Welcome to My World¶
This is a beautiful world,this is my world¶
❤️This is a simple record of learning bits and pieces , so that each step of learning into an unforgettable memory.
❤️To improve my writing skills
❤️The future is promising
Introduction¶
😶😐🤨🤨🙂😀😀😄😋
The world hides my learning notes, including machine learning, in-depth learning, and of course, algorithm —— the soul , welcome small partners to visit, if there are shortcomings, please come forward, I will accept and accept your suggestions with open heart
Theme Color ¶
Dominant Color¶
默认为
white
点击色块可更换主题的主色
Auxiliary Colour¶
默认为
red
点击色块更换主题的辅助色
MkDocs Environmental Description¶
-
python: 3.6.6
-
依赖的python包:
包名 | 模块名 | 版本 |
---|---|---|
mkdocs | mkdocs | 1.0.4 |
mkdocs-material | material | 3.0.6 |
Markdown | markdown | 3.0.1 |
pymdown-extensions | pymdownx | 6.0 |
mkdocs-material Deploy¶
Install¶
1 | pip install mkdocs mkdocs-material |
Initialization Project¶
1 | mkdocs new my-project |
The my-project directory is generated, and when you enter it, you can see that some files, including mkdocs.yml, are placed by default, which is the main configuration file.
Modify the Theme¶
In mkdocs.yml add:
1 2 | theme: name: material |
Add Pages¶
In mkdocs.yml add:
1 2 3 4 5 6 7 8 9 10 | nav: - 介绍: index.md - 安装: - 本地环境搭建: install/local.md - 发布至GitHub Pages: install/github-pages.md - 发布至自己的HTTP Server: install/http-server.md - 语法: - 语法总览: syntax/main.md - 标题: syntax/headline.md - 段落: syntax/paragraph.md |
Adding Extensions¶
In mkdocs.yml add:
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 | markdown_extensions: - admonition - codehilite: guess_lang: false linenums: false - toc: permalink: true - footnotes - meta - def_list - pymdownx.arithmatex - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.critic - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:pymdownx.emoji.to_png - pymdownx.inlinehilite - pymdownx.magiclink - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences - pymdownx.tasklist - pymdownx.tilde |
Mkdocs Service Startup¶
1 2 | # 在my-project目录里执行 mkdocs serve |
Open through the browser to see the effect http://127.0.0.1:8000/
Learn more¶
You can visit Mkdocs-github pages. Of course mkdocs-material is good!