Skip to content

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

  • 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.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Other

This is a emoji test ⚽

Continue the setup here : https://jameswillett.dev/getting-started-with-material-for-mkdocs/#setting-logo-to-an-image

And here (14 36) : https://www.youtube.com/watch?v=xlABhbnNrfI