Welcome to MkDocs

First Steps

  • Isard Register - Enter in your personal portal
  • Install Virtual Machine - Select Debian12 and Dockers.
  • Pip install mkdocs - Install Mkdocs with Terminal.
  • Start your own project - Get more help through this link mkdocs.org.

Problems

1. You don't have the register Isard  code
* `Tell your teacher`
2. You don't have Isard Code
* `Watch your friend`
3. Pip install mkdocs
* `sudo apt update && sudo apt install pip`
* `sudo apt install python3.11-venv`
* `python3 -m venv mkdocs`
* `source mkdocs/bin/activate`
* `pip install mkdocs`
* `mkdocs new project`  
* `mkdocs serve`

Start your own project

  • mkdocs.yml - The configuration file.
  • docs/ index.md - The documentation homepage ... - Other markdown pages and other files

Theme

  1. Go to your configuration file (explained)
  2. Add 'Theme:' section

  3. Write the name of the theme, in this case is "readthedocs"

    • site_name:
    • nav:
      • Home: index.md
      • About: about.md
    • theme: readthedocs