You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
akkoma/docs
floatingghost 8c86a06ed1
ci/woodpecker/push/woodpecker Pipeline is pending Details
Merge pull request 'Remove "default" image description' (#493) from ilja/akkoma:remove_default_image_description into develop
2 months ago
..
docs Merge pull request 'Remove "default" image description' (#493) from ilja/akkoma:remove_default_image_description into develop 2 months ago
theme/partials Documentation updates for stable release (#73) 11 months ago
Makefile add manual deploy for docs 7 months ago
Pipfile Documentation updates for stable release (#73) 11 months ago
Pipfile.lock varnish config/docs (#342) 6 months ago
README.md typo + remove unneeded file 4 months ago
mkdocs.yml Add dark and light theme mode to docs, detection, and button 6 months ago
requirements.txt fix requirements 7 months ago

README.md

Building the docs

You don't need to build and test the docs as long as you make sure the syntax is correct. But in case you do want to build the docs, feel free to do so.

# Make sure you're in the same directory as this README
# From the root of the Akkoma repo, you'll need to do
cd docs

# Optionally use a virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Run an http server who rebuilds when files change
# Accessable on http://127.0.0.1:8000
mkdocs serve

# Build the docs
# The static html pages will have been created in the folder "site"
# You can serve them from a server by pointing your server software (nginx, apache...) to this location
mkdocs build

# To get out of the virtual environment, you do
deactivate