diff --git a/docs/index.md b/docs/index.md index 1e8e45e..7f8e80d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,8 +16,8 @@ Follow the tutorial to add an existing project or create a project from scratch. - Install and configure a new or existing project. - Run it locally. - Deploy it. -- **Copy this project to your repos** - - [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) +- **Add a copy of this project to your repos** + - [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](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. diff --git a/docs/tutorial/installation.md b/docs/tutorial/installation.md index 0864b1e..54d1ff2 100644 --- a/docs/tutorial/installation.md +++ b/docs/tutorial/installation.md @@ -4,7 +4,7 @@ ## Requirements -- [Python](https://www.python.org/) +- [Python 3](https://www.python.org/) ## Install system dependencies @@ -35,17 +35,22 @@ python3 -m venv venv Activate it. -``` +```sh source venv/bin/activate ``` Install dependencies. -```sh -pip install mkdocs -``` +- Directly. + ```sh + pip install mkdocs + ``` +- Or use a `requirements.txt` file with `mkdocs` in it. + ```sh + pip install -r requirements.txt + ``` -### Globally +### Install globally If you prefer to install MkDocs once and reuse it across projects, you can install it globally. diff --git a/docs/tutorial/tldr.md b/docs/tutorial/tldr.md index 1e8498c..fa86c9a 100644 --- a/docs/tutorial/tldr.md +++ b/docs/tutorial/tldr.md @@ -2,17 +2,27 @@ > A simplified version of the tutorial. -## Local setup and deploy +## Local setup -1. `pip install mkdocs` -2. Setup project - - Generate new - `mkdocs new .` - - Copy this project - [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) -3. `mkdocs serve` -4. `mkdocs gh-deploy` -5. View published site on Github Pages at `https://USERNAME.github.io/REPO-NAME/` +1. [Install](installation.md) + - `pip install mkdocs` +2. [Setup project](setup_project.md) + - `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) +3. [Run](usage.md) + - `mkdocs serve` +4. View on [http://localhost:8000](http://localhost:8000) -## Remote deploy +## Deploy to remote site -For CI/CD deploy, use Github Actions with an action such as [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs). This is not covered in this tutorial. +### Run deploy command locally + +1. [Deploy](deploy.md) to Github Pages + - `mkdocs gh-deploy` +2. View published site on Github Pages at `https://USERNAME.github.io/REPO-NAME/` + +### Run continuous integration + +For CI/CD deploy, use Github Actions with an action such as [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs). Or use Netlify. + +This is not covered in this tutorial.