Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix README.md spelling bug #59

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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.