From 5dd48b27240c94d35e9e9d1adc3109244ae76404 Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Tue, 20 Jul 2021 22:24:04 +0200 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e697a63..adbd768 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,11 @@ A template, live demo and tutorial for how to set up a MkDocs docs site on GH Pages. Using GitHub Actions to automated deploys. -MkDocs is a Python package when turns your docs directory and YAML config into a static website. No Python coding needed. +MkDocs is a Python package when turns your docs directory and YAML config into a static website. No Python coding needed. Just Markdown and some light configuration including a theme choice and menu. + ## Purpose This project provides low-code content-focused way to set up and host a markdown-based documentation site, with a professional look and themes. Built with MkDocs - a Python package which is a static site generator specializing in documentation. @@ -24,9 +25,21 @@ A GitHub Actions workflow is provided with this template so you can easily deplo ## Preview +
+ [![Sample screenshot](/sample.png)](https://michaelcurrin.github.io/mkdocs-quickstart/ "Sample screenshot") -This project uses the _Read the Docs_ theme, as shown above. It comes with MkDocs so you don't need to add to your dependencies. But you can switch to the MkDocs default or install and configure another theme. +
+ +This template project is configured to use the _Read the Docs_ theme, as shown above. + +Thus looks like the the [Read The Docs][] site, but without having to have to overhead of using Sphinx. + +[Read The Docs]: https://docs.readthedocs.io + +This Read the Docs theme for MkDocs comes with MkDocs already, so you don't need to add to your dependencies. But you can switch to the MkDocs default or install and configure another theme. + +You can switch to the default theme or install some others, based on the instructions in this template project. ## How to use this project