akkoma

History

ilja 3a13f91fff Adapt some migrations so they can be rolled back This is useful for people who want to migrate back to Pleroma. It's also added in the docs, but also noted that this is barely tested and to be used at their own risk.		2023-06-09 22:02:26 +02:00
..
docs	Adapt some migrations so they can be rolled back	2023-06-09 22:02:26 +02:00
theme/partials	Documentation updates for stable release (#73 )	2022-07-15 12:27:16 +00:00
Makefile	add manual deploy for docs	2022-11-10 10:55:57 +00:00
mkdocs.yml	Add dark and light theme mode to docs, detection, and button	2022-12-09 22:51:43 -05:00
Pipfile	Documentation updates for stable release (#73 )	2022-07-15 12:27:16 +00:00
Pipfile.lock	varnish config/docs (#342 )	2022-12-05 13:39:27 +00:00
README.md	typo + remove unneeded file	2023-02-02 14:37:45 +01:00
requirements.txt	fix requirements	2022-11-11 16:07:07 +00:00

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