loading...

MkDocs Material Boilerplate - Starter Kit

peaceiris profile image peaceiris ใƒปUpdated on ใƒป2 min read

MkDocs Material


Overview

I released MkDocs Material Boilerplate - Starter Kit ๐Ÿš€

๐Ÿ‘‰ peaceiris/mkdocs-material-boilerplate - GitHub

MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with Docker, pipenv, and GitHub Actions.

Issues, pull requests, comments, and GitHub star โญ๏ธ are welcomeโ—๏ธ


What is MkDocs

MkDocs is one of the best static site generators. We can write our document using markdown and MkDocs builds static site from markdown.

MkDocs Material is one of the MkDocs theme based on Material Design.


Deploy to platforms

We have a lot of choices to manage documentation and deploy it.

This boilerplate includes build and deploy settings. We can easily publish our documentation right nowโ—๏ธ

๐Ÿ‘‰ Demo site on GitHub Pages (build & deploy with GitHub Actions)


More

Go to peaceiris/mkdocs-material-boilerplate - GitHub to get more information.

Thanks for reading and enjoy MkDocsโ—๏ธ

GitHub logo peaceiris / mkdocs-material-boilerplate

MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with CircleCI, Docker, pipenv, GitHub Actions

MkDocs icon
MkDocs Material
Boilerplate - Starter Kit

Eyecatch image of MkDocs Material Boilerplate (Starter Kit)

license release GitHub release date GitHub Actions status

Netlify Status Docker Hub Build Status

Details

Read more ๐Ÿ‘‰ Documentation - MkDocs Material Boilerplate

Quick start

git clone https://github.com/peaceiris/mkdocs-material-boilerplate.git
cd mkdocs-material-boilerplate
pipenv sync --dev
pipenv shell
inv serve --config-file mkdocs-sample.yml

Links

License

Support author




Discussion

pic
Editor guide