pcoet.github.io

Install

python3 -m venv mkdocs-env
source mkdocs-env/bin/activate
pip install mkdocs-material

Activate

source mkdocs-env/bin/activate

Deactivate

deactivate

Build

mkdocs build

Serve

mkdocs serve

Publish

The docs are automatically published when you push to main. Alternatively, you can run:

mkdocs gh-deploy --force

TODOs

• Learn mkdocs:
  • https://www.mkdocs.org/
  • https://squidfunk.github.io/mkdocs-material/
• Enable navigation tabs after you have docs subdirectories (the config is currently commented out in mkdocs.yml).

Content

• Create tutorials/index.md.
• Review old blog posts:
  • go-quickstart.md
  • grids.md
  • py-quickstart.md
  • ts-add-linting.md
    • Add a callout pointing to the new TypeScript quickstart tutorial.
  • ts-add-tests.md
    • Add a callout pointing to the new TypeScript quickstart tutorial.
  • ts-generics.md
  • ts-quickstart.md
    • Add a callout pointing to the new TypeScript quickstart tutorial.
  • vim-cookbook.md
• Review tutorials:
  • go-quickstart.md
  • ts-quickstart.md
• Create a Jupyter tutorial.
• Create a series of blog posts on functional programming.