From 49d6ee84a78170aa2d64bf8fe82f76081db99e9c Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Sat, 17 Oct 2020 16:54:30 +0200 Subject: [PATCH] docs: Update docs --- docs/about-mkdocs.md | 4 ++-- docs/tutorial/setup-project.md | 3 +-- docs/tutorial/usage.md | 2 -- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/about-mkdocs.md b/docs/about-mkdocs.md index dfc3758..7b1f135 100644 --- a/docs/about-mkdocs.md +++ b/docs/about-mkdocs.md @@ -7,7 +7,7 @@ The description on the MkDocs site is: > Project documentation with Markdown. -MkDocs is a Python tool generates a static site based on content written in *markdown*. +MkDocs is a Python tool that generates a static site based on content written in Markdown. If you are new to markdown, see the [Getting Started](https://www.markdownguide.org/getting-started/) page on the Markdown Guide website. @@ -37,4 +37,4 @@ If you are new to markdown, see the [Getting Started](https://www.markdownguide. ## Do I need to know Python? -MkDocs is built in Python (like Sphynx), but you don't have to write Python code. If you setup a [Deploy](deloy) flow right, you don't even have to set it up locally, though then you can't preview. +MkDocs is built in Python (like Sphinx), but you don't have to write Python code. If you setup a [Deploy](deploy) flow right, you don't even have to set it up locally, though then you can't preview. diff --git a/docs/tutorial/setup-project.md b/docs/tutorial/setup-project.md index f55ab26..0608b5b 100644 --- a/docs/tutorial/setup-project.md +++ b/docs/tutorial/setup-project.md @@ -25,7 +25,7 @@ This is the simplest MkDocs site you can make: A requirements file is optional but it can make it easier to manage dependencies. If you choose not use the file, make sure `pip install mkdocs` and `pip install THEME` lines are your instructions. -If you want to add, then include `requirements.txt` at the root. If your project is already a Python project, you might prefer to add `mkdocs` in `dev-requirements.txt` or at `docs/requirements.txt` to keep it isolated.This file should have `mkdocs` in it and also any themes if needed. +If you want to add, then include `requirements.txt` at the root. If your project is already a Python project, you might prefer to add `mkdocs` in `requirements-dev.txt` or at `docs/requirements.txt` to keep it isolated.This file should have `mkdocs` in it and also any themes if needed. ### Create a starter site @@ -39,7 +39,6 @@ mkdocs new PATH The result will be same as the [Basic structure](#basic-structure) defined above and will include minimal text content generated by the MkDocs CLI. This text is defined in the project's [new.py](https://github.com/mkdocs/mkdocs/blob/master/mkdocs/commands/new.py) module. - ### Setup a docs site _Tip: Optionally use the `new` command covered above to setup the config and index page first and then continue_. diff --git a/docs/tutorial/usage.md b/docs/tutorial/usage.md index 606bbe3..6f0c7ff 100644 --- a/docs/tutorial/usage.md +++ b/docs/tutorial/usage.md @@ -1,8 +1,6 @@ # Usage > Build and preview a site locally -_Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in `.vscode/tasks.json`. However, using a `Makefile` allows more control locally and on for a remote build._ - ## Serve docs