FilesExpand file tree

main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

177 lines (173 loc) · 5.51 KB

main

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

177 lines (173 loc) · 5.51 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

site_name: FastAPI-fastkit

site_description: Fast, easy-to-use starter kit for new users of Python and FastAPI

site_url: https://bnbong.github.io/FastAPI-fastkit/

repo_name: bnbong/FastAPI-fastkit

repo_url: https://github.com/bnbong/FastAPI-fastkit

theme:

custom_dir: overrides

name: material

font:

text: JetBrains Mono

# Light and Dark Theme Toggle

palette:

- media: "(prefers-color-scheme: light)"

scheme: default

primary: custom

accent: brown

toggle:

icon: material/brightness-7 # current mode : light

name: Switch to dark mode

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: custom

accent: brown

toggle:

icon: material/brightness-4 # current mode : dark

name: Switch to light mode

features:

- navigation.indexes

- navigation.footer

- navigation.top

- navigation.tracking

- navigation.tabs

- navigation.tabs.sticky

- navigation.expand

- search.highlight

- search.share

- search.suggest

- announce.dismiss

- toc.follow

logo: img/FastAPI-fastkit_logo.png

favicon: img/FastAPI-fastkit_logo.png

language: en

plugins:

# Material for MkDocs

- search

# Multi-language support

- i18n:

docs_structure: folder

fallback_to_default: true

reconfigure_material: true

reconfigure_search: true

languages:

- locale: en

default: true

name: English

build: true

- locale: ko

name: 한국어

build: true

nav_translations:

Home: 홈

User Guide: 사용자 가이드

Tutorial: 튜토리얼

Contributing: 기여하기

Reference: 레퍼런스

Changelog: 변경 로그

- locale: ja

name: 日本語

build: true

nav_translations:

Home: ホーム

User Guide: ユーザーガイド

Tutorial: チュートリアル

Contributing: 貢献

Reference: リファレンス

Changelog: 変更履歴

- locale: zh

name: 中文

build: true

nav_translations:

Home: 首页

User Guide: 用户指南

Tutorial: 教程

Contributing: 贡献

Reference: 参考

Changelog: 更新日志

- locale: es

name: Español

build: true

nav_translations:

Home: Inicio

User Guide: Guía del Usuario

Tutorial: Tutorial

Contributing: Contribuir

Reference: Referencia

Changelog: Registro de Cambios

- locale: fr

name: Français

build: true

nav_translations:

Home: Accueil

User Guide: Guide de l'Utilisateur

Tutorial: Tutoriel

Contributing: Contribuer

Reference: Référence

Changelog: Journal des Modifications

- locale: de

name: Deutsch

build: true

nav_translations:

Home: Startseite

User Guide: Benutzerhandbuch

Tutorial: Tutorial

Contributing: Beitragen

Reference: Referenz

Changelog: Änderungsprotokoll

nav:

- Home: index.md

- User Guide:

- Installation: user-guide/installation.md

- Quick Start: user-guide/quick-start.md

- Choosing a Starter: user-guide/choosing-a-starter.md

- Creating Projects: user-guide/creating-projects.md

- Adding Routes: user-guide/adding-routes.md

- Using Templates: user-guide/using-templates.md

- CLI Reference: user-guide/cli-reference.md

- Tutorial:

- Getting Started: tutorial/getting-started.md

- Your First Project: tutorial/first-project.md

- Implementing Basic API Server: tutorial/basic-api-server.md

- Implementing Asynchronous CRUD API: tutorial/async-crud-api.md

- Domain-oriented Project (Domain Starter): tutorial/domain-starter.md

- JWT Authentication: tutorial/auth-jwt.md

- Async Persistence with SQLModel: tutorial/sqlmodel.md

- Streaming LLM Agent: tutorial/llm-agent.md

- Database Integration: tutorial/database-integration.md

- Docker Deployment: tutorial/docker-deployment.md

- Implementing Custom Response Handling: tutorial/custom-response-handling.md

- Implementing MCP Server: tutorial/mcp-integration.md

- Contributing:

- Development Setup: contributing/development-setup.md

- Code Guidelines: contributing/code-guidelines.md

- Template Creation Guide: contributing/template-creation-guide.md

- Translation Guide: contributing/translation-guide.md

- Reference:

- FAQ: reference/faq.md

- Architecture Preset Matrix: reference/preset-feature-matrix.md

- Template Quality Assurance: reference/template-quality-assurance.md

- Translation Status: reference/translation-status.md

- Changelog: changelog.md

markdown_extensions:

# Python Markdown

- abbr

- attr_list

- footnotes

- md_in_html

- mdx_include

- admonition

- pymdownx.details

# PyMdown Extensions

- pymdownx.highlight: # necessary for code blocks & termynal

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite # necessary for code blocks & termynal

- pymdownx.snippets # necessary for code blocks & termynal

- pymdownx.superfences # necessary for code blocks & termynal

extra_css:

- css/termynal.css

- css/custom.css

extra_javascript:

- js/termynal.js

- js/custom.js