MkDocs / Resources

The following are useful resources.

MkDocs

• MkDocs website
  • Writing your docs - explains file organization, formatting, document links

MkDocs Themes

• Material
  • Getting Started - also contains useful MkDocs general information
  • Material Design - user interface components that go beyond MkDocs
  • Material icons - modern and clean icons
• MkDocs Themes on GitHub
• MkDocs Bootswatch Project Themes on GitHub

Markdown

• Markdown on Wikipedia
• Mastering Markdown on GitHub
• Adam Pritchard's Markdown Cheatsheet
• GitHub Markdown language support - use to format code blocks

Git Version Control

• .gitattributes - used to indicate per-repository settings, including how to handle line endings
• .gitignore - used to ignore files, such as MkDocs-generated site folder