Skip to content

Instantly share code, notes, and snippets.

@MaedahBatool

MaedahBatool/mkdocs.md

Last active November 19, 2017 16:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save MaedahBatool/f435e0b7ec178d467ce6cf73cae3e7f5 to your computer and use it in GitHub Desktop.
Save MaedahBatool/f435e0b7ec178d467ce6cf73cae3e7f5 to your computer and use it in GitHub Desktop.
Download ZIP
MkDocs Starter!
Raw
mkdocs.md

MkDocs Workflow! 🍒

  1. Run mkdocs new project_name.
  2. Open that folder by cd project_name.
  3. Make a new GitHub repo.
  4. Copy new Git repo instructions (the first one).
  5. Run it in the project root folder.
  6. Run echo "site/" >> .gitignore.
  7. Run gcap 'NEW Project' (gcap` = Git Commit All Push — My personal workflow alias).
  8. Run mkdocs serve
  9. Start documenting → http://www.mkdocs.org/#getting-started
  10. Run gcap after all changes.
  11. Deploy with mkdocs gh-deploy.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment