From 3e735f3893b90a127da5df94100353d53777d3ef Mon Sep 17 00:00:00 2001 From: Michael Currin Date: Sat, 2 May 2020 23:26:35 +0200 Subject: [PATCH] docs: Update description --- README.md | 2 +- docs/index.md | 2 +- mkdocs.yml | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a42ba8e..8b4e6f5 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.md b/docs/index.md index 42bb36a..c49f9f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 7b57eea..d88dc18 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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/