From 52a8f7862a05db2b95d604fb96155c623a498ce1 Mon Sep 17 00:00:00 2001 From: Michael Currin Date: Sun, 3 May 2020 10:01:04 +0200 Subject: [PATCH] feat: Update pages --- docs/deploy.md | 1 + docs/setup_and_run.md | 27 ++++++++++++++++++++++----- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/deploy.md b/docs/deploy.md index daee53f..66d31ee 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -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: diff --git a/docs/setup_and_run.md b/docs/setup_and_run.md index 1ef59a4..ccbee53 100644 --- a/docs/setup_and_run.md +++ b/docs/setup_and_run.md @@ -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.