electrichive/electric-hivemind

Programming learning knowledgebase

electric-hivemind

Electric Hivemind is a programming learning knowledgebase.

The project is built on top of mkdocs-material and mkdocs.org.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files

Installation

Requirements

• Optional: pyenv for Python version management
• Python ~3.10.10
• pip
• Poetry

poetry install

Usage

Commands

* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

See License