Skip to main content

Introduction

These are the notes for the documentation site you are viewing. Some commands that will help me maintain this site.

Hosting and deploys​

  • This site is hosted on github repo
  • To push any new change type in
	mkdocs gh-deploy

  • I have written a script that will deploy the code automatically with the command deploynotes

  • To preview the changes locally use the command

	mkdocs serve
  • I have written a script that will run the code locally with the command viewnotes

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.