https://github.com/sosiristseng/template-mkdocs-material

Template for documentation site using mkdocs-material
https://github.com/sosiristseng/template-mkdocs-material

documentation mkdocs mkdocs-material template

Last synced: 1 day ago
JSON representation

Template for documentation site using mkdocs-material

• Host: GitHub
• URL: https://github.com/sosiristseng/template-mkdocs-material
• Owner: sosiristseng
• License: mit
• Created: 2021-07-24T15:38:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T02:02:33.000Z (9 months ago)
• Last Synced: 2024-04-04T01:42:49.592Z (9 months ago)
• Topics: documentation, mkdocs, mkdocs-material, template
• Homepage: https://sosiristseng.github.io/template-mkdocs-material/
• Size: 835 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mkdocs material theme template

[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

- [Mkdocs](https://www.mkdocs.org/) with the beautiful [material theme](https://squidfunk.github.io/mkdocs-material/) turns markdown (`.md`) files into a documentation site.

- GitHub actions build and publish the website automatically whenever changes are pushed to the repository.

## On GitHub

Click `Use this template` green button to copy this repository to your place.

Open your repository settings => Pages => GitHub Pages

=> Build and deployment => Source, Select `GitHub actions`