Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
132 lines (124 loc) · 4.99 KB
/
Copy pathmkdocs.yml
File metadata and controls
132 lines (124 loc) · 4.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: cubrid-cookbook-python
site_description: Runnable Python examples and production-shaped templates for CUBRID
site_author: cubrid-lab
site_url: https://cubrid-lab.github.io/cubrid-cookbook-python/
repo_url: https://github.com/cubrid-lab/cubrid-cookbook-python
edit_uri: edit/main/docs/
theme:
name: material
# CUBRID Lab repository icon, pinned to an immutable cubrid-lab/brand commit.
logo: https://raw.githubusercontent.com/cubrid-lab/brand/e55990a6a0b2c3b0d133985951d41e42b62a8588/dist/icons/cubrid-cookbook-python.svg
favicon: https://raw.githubusercontent.com/cubrid-lab/brand/e55990a6a0b2c3b0d133985951d41e42b62a8588/dist/icons/cubrid-cookbook-python.svg
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- navigation.footer
- content.code.copy
- search.highlight
- search.suggest
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to light mode
extra_css:
- stylesheets/brand.css
nav:
- Home: index.md
- Start here:
- "New to CUBRID? Start here (lesson 1: prepare the lab)": first-cubrid.md
- "Lesson 2: Run your first query": first-cubrid-first-query.md
- "Lesson 3: Save rows and read them back": first-cubrid-save-a-row.md
- "Lesson 4: Undo a change with rollback": first-cubrid-rollback.md
- "Lesson 5: Finish safely": first-cubrid-finish.md
- Optional goals:
- "Build a small web API (FastAPI quickstart)": quickstart-fastapi.md
- "Use the ORM (SQLAlchemy quickstart)": quickstart-sqlalchemy.md
- How-to guides:
- "Choose a path and verify a checkout (Getting Started)": getting-started.md
- "Watch recorded walkthroughs (Quick Start)": quickstart.md
- Full example catalog: catalog.md
- Fundamentals overview: fundamentals.md
- pycubrid recipes: fundamentals-pycubrid.md
- SQLAlchemy recipes: fundamentals-sqlalchemy.md
- pandas recipes: fundamentals-pandas.md
- "Pass values safely (parameterized queries)": fundamentals-parameterized-queries.md
- "Move from CUBRIDdb to pycubrid": migration-cubriddb-to-pycubrid.md
- Performance patterns: performance.md
- CUBRID quirks & pitfalls: pitfalls.md
- Templates:
- FastAPI service: template-api-service-fastapi.md
- Celery async worker: template-async-worker.md
- pandas batch ETL: template-batch-etl.md
- Streamlit dashboard: template-dashboard.md
- Django app: template-django.md
- Flask app: template-flask.md
- AI agent: template-ai-agent.md
- Reference:
- Support matrix: support-matrix.md
- Help:
- Known issues: known-issues.md
- "Ask a question or report a bug": https://github.com/cubrid-lab/cubrid-cookbook-python/issues/new/choose
- "Report a vulnerability privately": https://github.com/cubrid-lab/cubrid-cookbook-python/blob/main/SECURITY.md
- 한국어:
- 한국어 README: README.ko.md
- 여기서 시작:
- "CUBRID가 처음이라면 (1단원: 실습 환경 준비)": ko/first-cubrid.md
- "2단원: 첫 쿼리 실행하기": ko/first-cubrid-first-query.md
- "3단원: 행 저장하고 다시 읽기": ko/first-cubrid-save-a-row.md
- "4단원: rollback으로 변경 되돌리기": ko/first-cubrid-rollback.md
- "5단원: 안전하게 마치기": ko/first-cubrid-finish.md
- 선택 목표:
- "작은 웹 API 만들기 (FastAPI 빠른 시작)": ko/quickstart-fastapi.md
- "ORM 쓰기 (SQLAlchemy 빠른 시작)": ko/quickstart-sqlalchemy.md
- 사용 방법:
- "경로 고르기와 체크아웃 검증 (시작하기)": ko/getting-started.md
- "CUBRIDdb에서 pycubrid로 이전": ko/migration-cubriddb-to-pycubrid.md
- Project:
- Changelog: changelog.md
markdown_extensions:
- admonition
- toc:
permalink: true
toc_depth: 3
- tables
- attr_list
- md_in_html
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
plugins:
- search
# docs/internal/ holds planning material (PRD); keep it out of the rendered
# site and the search index. Staged pages link to it on GitHub instead.
exclude_docs: |
internal/
# Staged pages have their relative links rewritten by scripts/stage_docs.py, so
# any link MkDocs still cannot resolve is a real break: these warnings fail
# `mkdocs build --strict` (make docs, CI).
validation:
nav:
omitted_files: ignore
links:
not_found: warn
unrecognized_links: warn
anchors: warn
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/cubrid-lab/cubrid-cookbook-python