https://github.com/ben-basten/wiki

Keep track of daily work using shell scripts, markdown, and mkdocs.
https://github.com/ben-basten/wiki

Last synced: 28 days ago
JSON representation

Keep track of daily work using shell scripts, markdown, and mkdocs.

• Host: GitHub
• URL: https://github.com/ben-basten/wiki
• Owner: ben-basten
• Created: 2023-12-11T17:44:40.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-19T00:52:43.000Z (9 months ago)
• Last Synced: 2024-10-08T10:19:03.837Z (about 1 month ago)
• Language: Shell
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# wiki

## Installation

1. Check that python / pip are installed

    ```

    python3 --version

    pip3 --version

    ```

2. _Optional:_ set up a Python virtual environment

   - `python3 -m venv .venv` - initialize the virtual environment

   - `source .venv/bin/activate` - active the virtual environment

3. Install dependencies

   - `pip3 install mkdocs`

   - `pip3 install mkdocs-material`

4. ...and you're off to the races!

## Running mkdocs

**Local server**

`mkdocs serve`

**Build static html**

`mkdocs build`

Files will be built into the `site` folder, which is not checked into Git.

## Helpful scripts

* Generate new pattern page: `./pattern.sh "Your Pattern Title"`

## Documenation

* [mkdocs](https://www.mkdocs.org/user-guide/installation/)

* [mkdocs-material theme](https://squidfunk.github.io/mkdocs-material/)