# TL;DR

> A simplified version of the tutorial.

## Local setup

1. Install
   - `pip install mkdocs`
2. Set up project
   - `mkdocs new .` or
3. Run
   - `mkdocs serve`
4. View on localhost:8000

## Deploy to remote site

### Run deploy command locally

1. Deploy 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. Or use Netlify.

This is not covered in this tutorial.

GitHub « Previous Next »