From e9191c82e95aea947ab93890a44e37044ee0f2f8 Mon Sep 17 00:00:00 2001 From: YiXuan Ding <1328032567@qq.com> Date: Thu, 24 Oct 2024 20:36:11 +0800 Subject: [PATCH] Fix README.md spelling bug There is a little spell and expresssion bugs, and I've fixed them all. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 963f8128..5a11d407 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ Our docs use extended markdown as implemented by MkDocs. * create a python3 environment `python -m venv env` * activate the python environment `source env/bin/activate` * install MkDocs `pip install mkdocs` -* install MkDocs redirect `pin install mkdocs-redirects` -* `mkdocs serve` starts a local webserver at localhost:8000. This is a live server; it will be updated when you save any of the .md files in the docs folder. So you should be running this as you make changes so you can see their effects. +* install MkDocs redirect `pip install mkdocs-redirects` +* `mkdocs serve` starts a local webserver at localhost:8000. This is a live server; it will be updated when you save any of the .md files in the docs folder. So you should be running this as you make changes so you can see their effects. * `mkdocs build` Builds a static site in `./site` directory * config docs by editing `./mkdocs.yml` @@ -28,4 +28,4 @@ You can execute it locally via docker: docker run -v $PWD:/markdown:ro 06kellyjac/markdownlint-cli . ``` -For linting rules see `.markdownlint`, for now this is very relaxed set. +For linting rules, please see `markdownlint`. For now, this is a very relaxed set.