https://github.com/ajaust/mkdocs-poster-tutorial
https://github.com/ajaust/mkdocs-poster-tutorial
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ajaust/mkdocs-poster-tutorial
- Owner: ajaust
- Created: 2020-07-24T11:00:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-30T06:31:03.000Z (almost 6 years ago)
- Last Synced: 2025-03-12T22:11:16.189Z (over 1 year ago)
- Language: Shell
- Size: 2.17 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mkdocs-poster-tutorial
This README briefly explains what software needs to be installed and where to find further documentation
## Installing dependencies
The **mandatory** requirements for the tutorial are `mkdocs` and the `mkdocs-material` theme. This includes some dependencies such as `Pygments` and `pymdown-extensions`. This might be available via your package manager, but the packages might be old.
1. Install pip for python3
```
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py --user
```
2. Install needed packages (List might be incomplete)
```
pip3 install --user mkdocs mkdocs-material Pygments pymdown-extensions
```
The **optional** dependencies are:
- `ffmpeg`: Encoding/decoding videos
- `asciinema`: Small videos of your terminal
```bash
sudo apt-get install ffmpeg asciinema
```
## Documentation
- MkDocs: https://www.mkdocs.org/
- Material theme: https://squidfunk.github.io/mkdocs-material/
- Markdown (cheat sheet): https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
- ffmpeg: https://ffmpeg.org/documentation.html
- asciinema: https://asciinema.org/docs/
## Quickstart
Create page: `mkdocs serve`. You can check your homepage in a browser. The URL is usually http://127.0.0.1:8000/ Edit files: `mkdocs.yml` and `docs/index.md`