iarv/mkdocs-quickstart

mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-03-28 17:42:47 +01:00

Go to file

michaelcurrin 3400d5c4bb Update index.md

2020-06-01 10:14:20 +02:00

feat: Restructure and add content

2020-05-03 11:17:55 +02:00

Update index.md

2020-06-01 10:14:20 +02:00

.gitignore

chore: Create .gitignore

2020-05-02 22:14:27 +02:00

LICENSE

Initial commit

2020-05-02 22:13:07 +02:00

mkdocs.yml

chore: Move files to tutorial

2020-05-03 11:31:57 +02:00

README.md

Update README.md

2020-06-01 10:10:12 +02:00

sample.png

docs: Create sample.png

2020-05-19 13:20:56 +02:00

README.md

MkDocs Quickstart

A concise recipe for setting up a MkDocs docs site on Github Pages

Preview

Live site

This project has a site deployed to Github Pages.

Purposes:

A live demo
Content for a beginner-friendly tutorial on how to setup, run, deploy and customize a MkDocs project like this one.

Note: The deploy is currently manually triggered by a local command, however there are Issues open to setup CI/CI remote deploys with Netlify or Github Actions.

Template

License

Released under MIT.