💻 Dev Documentation

🧩 Setup

  • Run pip install mkdocs

⌨️ Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
    • this is running at 127.0.0.1:8000
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

!IMPORTANT:

  • Before pushing to develop branch, make sure to run mkdocs build so it'll reflect to vercel site.

  • Make sure to promote the preview to production once the branch has been updated.

Vercel Deployments

🛠️ Project layout

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