https://github.com/oldmanumby/material-for-mkdocs-template

An install template for Material for MkDocs.
https://github.com/oldmanumby/material-for-mkdocs-template

github github-pages installer mkdocs mkdocs-material template

Last synced: 21 days ago
JSON representation

An install template for Material for MkDocs.

• Host: GitHub
• URL: https://github.com/oldmanumby/material-for-mkdocs-template
• Owner: OldManUmby
• Created: 2024-07-07T14:58:45.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-22T17:43:51.000Z (6 months ago)
• Last Synced: 2024-10-16T13:08:35.094Z (3 months ago)
• Topics: github, github-pages, installer, mkdocs, mkdocs-material, template
• Homepage: https://oldmanumby.github.io/material-for-mkdocs-template/
• Size: 415 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Material for MkDocs Template

**PLEASE BE AWARE: THIS TEMPLATE IS STILL UNDER CONSTRUCTION.**

[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/) is a powerful [Markdown](https://www.markdownguide.org) documentation framework on top of [MkDocs](https://www.mkdocs.org), a static site generator for project documentation. This GitHub repo is a complete installation of Material for MkDocs, complete with many of the most useful YML settings.

I've set up this repo as a template specifically for the laymen. Click the green button "Use this Template" above to create a new documentation repo complete with GitHub Pages. It takes less than a few minutes! Then, add a domain (optional) and begin adding your markdown docs.

To view a more thorough step-by-step installation, including a running local instances, visit [James Willitt's YouTube video](https://youtu.be/Q-YA_dA8C20?si=l00iX2nvDRIFSwOb).

To customize the site, adjust the mkdocs.yml file to suit your needs; for more info on customizing the site, visit [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/).