A sugestão, ou antes a auto-sugestão, é um assunto completamente novo e ao mesmo tempo tão antigo quanto o mundo.
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.mkdocs gh-deploy
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
./assets/ # Other markdown pages, images and other files.
style.css
style.js
overrides/
main.html
```python --version```
Python 3.11.4
```mkdocs --version```
mkdocs, version 1.4.2 from C:\Python311\Lib\site-packages\mkdocs (Python 3.11)
```pip show mkdocs-material```
Name: mkdocs-material
Version: 8.2.7
Summary: A Material Design theme for MkDocs
Home-page: https://squidfunk.github.io/mkdocs-material/
Author: Martin Donath
Author-email: [email protected]
License: MIT
Location: C:\Python311\Lib\site-packages
Requires: jinja2, markdown, mkdocs, mkdocs-material-extensions, pygments, pymdown-extensions
```mike --version```
mike 1.1.2
🏆 📚 A list of awesome MkDocs projects and plugins. themes...
This is an example of the new versioning feature of
Next, set up your documentation project:
mkdocs new .
Update mkdocs.yml:
site_name: My Docs
theme:
name: material
extra:
version:
provider: mikeMake a change to docs/index.md, and publish the first version:
mike deploy --push --update-aliases 0.1 latest
Set the default version to latest
mike set-default --push latest
Now, make another change and publish a new version:
mike deploy --push --update-aliases 0.2 latest