mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-06-17 16:45:21 +02:00
docs: Update docs
This commit is contained in:
+1
-1
@@ -17,7 +17,7 @@ Follow the tutorial to add an existing project or create a project from scratch.
|
||||
- Run it locally.
|
||||
- Deploy it.
|
||||
- **Add a copy of this project to your repos**
|
||||
- [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||
- [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||
- **View the live demo**
|
||||
- This site is hosted on GitHub Pages. See if you like it. Other themes are available - see the tutorial.
|
||||
|
||||
|
||||
@@ -19,7 +19,11 @@ Choose or setup a MkDocs project.
|
||||
|
||||
Follow the tutorial page to setup a project.
|
||||
|
||||
Or click _Use this template_ on this repo to create your own copy of the repo, then clone it.
|
||||
Or click the button on this repo to create your own copy of the repo.
|
||||
|
||||
[](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||
|
||||
Then clone it.
|
||||
|
||||
e.g.
|
||||
|
||||
|
||||
@@ -7,10 +7,10 @@
|
||||
1. [Install](installation.md)
|
||||
- `pip install mkdocs`
|
||||
2. [Setup project](setup-project.md)
|
||||
- `mkdocs new .` or [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||
- `mkdocs new .` or [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||
3. [Run](usage.md)
|
||||
- `mkdocs serve`
|
||||
4. View on [http://localhost:8000](http://localhost:8000)
|
||||
4. View on [localhost:8000](http://localhost:8000)
|
||||
|
||||
|
||||
## Deploy to remote site
|
||||
|
||||
Reference in New Issue
Block a user