mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
feat: Update pages
This commit is contained in:
@@ -13,6 +13,7 @@ _Note this is for a Project Page and not Organization and User Pages._
|
||||
|
||||
### Run deploy command
|
||||
|
||||
MkDocs needs to know where to publish commits on Github - so make sure you are working with a repo that you cloned, or that you initialize the local repo and add a `remote` repo.
|
||||
|
||||
Run this command locally:
|
||||
|
||||
|
||||
@@ -1,20 +1,37 @@
|
||||
# Setup and run
|
||||
# Inst and run
|
||||
> How to setup and run a docs 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`._
|
||||
|
||||
## Install
|
||||
|
||||
Make sure you have Python installed - ideally a recent Python 3 version.
|
||||
|
||||
Install in a virtual environment.
|
||||
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.
|
||||
|
||||
|
||||
Create a virtual environment at the project root.
|
||||
|
||||
```sh
|
||||
python3 -m venv venv
|
||||
```
|
||||
|
||||
Install dependencies.
|
||||
|
||||
```sh
|
||||
pip install mkdocs
|
||||
```
|
||||
|
||||
|
||||
## Server docs locally
|
||||
## Usage
|
||||
|
||||
|
||||
_Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in `.vscode/tasks.json`._
|
||||
|
||||
|
||||
### Server docs locally
|
||||
|
||||
This will build the docs in memory (not to disk) and serve an auto-reloading server.
|
||||
|
||||
@@ -27,7 +44,7 @@ Open URL:
|
||||
- [localhost:8000](http://localhost:8000)
|
||||
|
||||
|
||||
## Build docs
|
||||
### Build docs
|
||||
|
||||
Build docs site to `site` directory. Useful for production build or simulating that locally.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user