docs: Update description

This commit is contained in:
Michael Currin
2020-05-02 23:26:35 +02:00
parent 7a07748602
commit 3e735f3893
3 changed files with 5 additions and 3 deletions

View File

@@ -1,2 +1,2 @@
# MkDocs Quickstart
> A concise recipe for setting up MkDocs docs site on Github Pages
> A concise recipe for setting up a MkDocs docs site on Github Pages

View File

@@ -1,5 +1,5 @@
# MkDocs Quickstart
> A concise recipe for setting up MkDocs docs site on Github Pages
> A concise recipe for setting up a MkDocs docs site on Github Pages
This is based on the [mkdocs.org](https://www.mkdocs.org/) tutorial.

View File

@@ -1,9 +1,11 @@
site_name: MkDocs Quickstart
site_description: 'A brief guide for setting up a MkDocs docs site on Github Pages'
# For SEO.
site_description: 'A concise recipe for setting up a MkDocs docs site on Github Pages'
nav:
- Home: index.md
- Setup and run: setup_and_run.md
- Tutorial: tutorial.md
- Deploy: deploy.md
theme: readthedocs
# For adding Edit in Github button.
repo_url: https://github.com/MichaelCurrin/mkdocs-quickstart/