feat: rename setup to set up

This commit is contained in:
Michael Currin
2021-06-08 18:00:21 +02:00
parent 16e004a200
commit 828bf66208
7 changed files with 15 additions and 19 deletions
+5 -8
View File
@@ -1,4 +1,4 @@
# Setup project
# Set up project
> How to create a MkDocs site from scratch
This is a summary of the tutorial on [mkdocs.org](https://www.mkdocs.org/).
@@ -9,8 +9,7 @@ This is a summary of the tutorial on [mkdocs.org](https://www.mkdocs.org/).
Use one of the approaches below:
- Create a quickstart project with the `new` command covered in [Create a starter site](#create-a-starter-site).
- Follow the extended guide to create a [Setup up docs site](#setup-a-docs-site) by hand.
- Follow the extended guide to create a [Set up up docs site](#setup-a-docs-site) by hand.
### Basic structure
@@ -29,14 +28,12 @@ Notes on fields for the config:
- `repo_url` - for _Edit on GitHub_ button. See [docs](https://www.mkdocs.org/user-guide/configuration/#repo_url).
- `edit_uri` - defaults to `edit/master/docs/`, which includes `docs` directory of markdown files inside your repo root. But, if the site's root is in an outer `docs` directory, then you need to _also_ add that, so paths do not break. e.g. `edit/master/docs/docs`. See [docs](https://www.mkdocs.org/user-guide/configuration/#edit_uri)
### Requirements file
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 `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
Run this command to create a starter site. This make the steps below go quicker.
@@ -48,9 +45,9 @@ 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
### Set up a docs site
_Tip: Optionally use the `new` command covered above to setup the config and index page first and then continue_.
_Tip: Optionally use the `new` command covered above to set up the config and index page first and then continue_.
1. Create doc pages.
1. Create a `docs` directory.
@@ -138,7 +135,7 @@ theme:
### Material for MkdDocs theme
See the [MkDocs for Material](https://squidfunk.github.io/mkdocs-material/) homepage. See the Setup page for config options.
See the [MkDocs for Material](https://squidfunk.github.io/mkdocs-material/) homepage. See the Set up page for config options.
`requirements.txt`:
```