Skip to content

Commit c413a83

Browse files
ClearXsClearXs
committed
docs: add mkdocs for uno framework
1 parent 011cff9 commit c413a83

File tree

3 files changed

+151
-0
lines changed

3 files changed

+151
-0
lines changed

‎mkdocs.yml

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
site_name: uno文档
2+
repo_name: uno
3+
repo_url: https://github.com/ClearXs/uno
4+
site_author: J.x ([email protected])
5+
copyright: Copyright © 2023 - 2024 ClearX
6+
7+
nav:
8+
- README.md
9+
- core: core.md
10+
- data: data.md
11+
- rule: rule.md
12+
- web: web.md
13+
- test: test.md
14+
- gis: gis.md
15+
- auto: auto.md
16+
- bom: bom.md
17+
- plugins: plugins.md
18+
- components:
19+
- http: components/http.md
20+
- kafka: components/kafka.md
21+
- media: components/media.md
22+
- netty: components/netty.md
23+
- sequential: components/sequential.md
24+
- websocket: components/websocket.md
25+
- starter: starter.md
26+
27+
theme:
28+
# https://squidfunk.github.io/mkdocs-material/creating-your-site/#configuration
29+
name: material
30+
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
31+
palette:
32+
- scheme: default
33+
toggle:
34+
icon: material/brightness-7
35+
primary: indigo
36+
accent: light blue
37+
- scheme: slate
38+
toggle:
39+
icon: material/brightness-4
40+
primary: indigo
41+
accent: grey
42+
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
43+
font:
44+
text: Nunito Sans
45+
code: Roboto Mono
46+
logo: favicon.png
47+
favicon: favicon.png
48+
features:
49+
# Navigation
50+
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
51+
- navigation.instant # some features may not work properly with XHR
52+
- navigation.tracking # the URL changes with the active anchor
53+
- navigation.instant.prefetch
54+
- navigation.tabs # first top-level folders are shown as tabs
55+
- navigation.tabs.sticky # tabs always show
56+
- navigation.prune
57+
- navigation.sections # second-level folders are expanded
58+
- navigation.expand # all folders are expanded
59+
- navigation.indexes # link an index page to its parent folder
60+
- navigation.top # show the back-to-top button
61+
- toc.integrate # show the table of contents in the navigation panel
62+
# Search
63+
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search
64+
- search.suggest # display the likeliest completion for the last word
65+
- search.highlight # highlight all occurrences
66+
- search.share # show a share button of the current search
67+
# Header
68+
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/
69+
- header.autohide # hide the post title when scroll down
70+
# Content
71+
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
72+
- content.code.annotate # add comment to code blocks
73+
- content.tabs.link # link tabs with the same label
74+
- content.tooltips
75+
76+
#
77+
# Plugins
78+
#
79+
plugins:
80+
- tags
81+
- search: # must be included at the first place
82+
lang:
83+
- en
84+
- zh
85+
separator: '[\s\u200b\-]'
86+
- offline
87+
#
88+
# Extensions
89+
#
90+
markdown_extensions:
91+
- abbr # add a small tooltip to elements
92+
- admonition # add call-out blocks
93+
- attr_list # allow to add HTML attributes and CSS classes
94+
- def_list # add description lists
95+
- footnotes # define inline footnotes
96+
- meta # attach arbitrary key-value pairs to a document
97+
- md_in_html # allow to write Markdown inside HTML elements
98+
- tables # create tables in Markdown
99+
- toc: # generate a table of contents from documents
100+
permalink: '#' # anchor
101+
toc_depth: 4 # header 1 to header 4
102+
slugify: !!python/name:pymdownx.slugs.uslugify # convert title to html-compatible text
103+
- sane_lists # make better lists
104+
- smarty: # convert some special characters
105+
smart_angled_quotes: true
106+
- pymdownx.highlight:
107+
anchor_linenums: true
108+
# - pymdownx.betterem: # improve the detection of Markup to emphasize text in Markdown
109+
# smart_enable: all
110+
- pymdownx.caret # define superscript
111+
- pymdownx.mark # highlight text
112+
- pymdownx.tilde # define subscript
113+
- pymdownx.critic # track changes
114+
- pymdownx.details # add collapsible call-outs
115+
- pymdownx.emoji: # add inlines bundled and custom icons and emojis
116+
emoji_index: !!python/name:materialx.emoji.twemoji
117+
emoji_generator: !!python/name:materialx.emoji.to_svg
118+
- pymdownx.superfences # define code blocks and nesting of code
119+
- pymdownx.highlight: # highlight of code blocks
120+
linenums_style: pymdownx-inline
121+
# anchor_linenums: true # create anchor link on each line of code
122+
- pymdownx.inlinehilite # highlight inline code blocks
123+
- pymdownx.smartsymbols # convert some sequences of characters into their corresponding symbols
124+
- pymdownx.snippets: # embed content from arbitrary files into a document
125+
check_paths: true
126+
- pymdownx.tabbed: # group related content and code blocks under accessible tabs
127+
alternate_style: true
128+
- pymdownx.tasklist: # define list of task with checkbox
129+
custom_checkbox: true
130+
- pymdownx.escapeall:
131+
hardbreak: true # use \ to create new line
132+
nbsp: true # use \<space> to create &nbsp;
133+
# - pymdownx.keys # syntax ++ctrl+c++ does not look clear in MD document
134+
- pymdownx.progressbar
135+
extra:
136+
version:
137+
provider: mike
138+
disqus: "vuquangtrong-github-io"

‎package.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"name": "turbo-docs",
3+
"version": "1.0.0",
4+
"description": "turbo documentation",
5+
"private": true,
6+
"scripts": {
7+
"dev": "mkdocs serve",
8+
"build": "mkdocs build -d public"
9+
}
10+
}

‎requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs
2+
mkdocs-material
3+
mkdocs-roamlinks-plugin

0 commit comments

Comments
 (0)