AkkomaGang/akkoma
AkkomaGang
/
akkoma
12
63
Fork 83
Code Issues 173 Pull Requests 13 Packages Projects 2 Releases 12 Wiki Activity

update readme of docs

This commit is contained in:
FloatingGhost 2022-07-14 16:59:11 +01:00
parent c923817559
commit e30c88d8e1
1 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md
View File

@ -1,21 +1,9 @@
# Pleroma documentation
This project contains a documentation skeleton and a script to fill it in with data, the resulting documentation can be viewed at <https://akkoma.dev/main>.
## Contributing to the documentation
If you want to suggest an edit, please refer to the `AkkomaGang/akkoma` and `AkkomaGang/pleroma-fe` repos.
We use [mkdocs](https://www.mkdocs.org/) to build the documentation and have the [admonition](https://squidfunk.github.io/mkdocs-material/extensions/admonition/) extensions that make it possible to add block-styled side content like example summaries, notes, hints or warnings. If you are unsure of how a specific syntax should look like, feel free to look through the docs for an example.
## 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.
You'll need to install mkdocs for which you can check the [mkdocs installation guide](https://www.mkdocs.org/#installation). Generally it's best to install it using `pip`. You'll also need to install the correct dependencies.
To build the docs you can clone this project and use the `manage.sh` script.
### Example using a Debian based distro
#### 1. Install pipenv and dependencies
@ -32,13 +20,9 @@ Since dependencies are installed in a virtual environment, you can't use them di
#### 3. Build the docs using the script
```shell
git clone https://git.pleroma.social/pleroma/docs
cd docs
[pipenv run] ./manage.sh all
[pipenv run] make all
```
`./manage.sh all` will fetch the docs from the pleroma and pleroma-fe repos and build the documentation locally. To see what other options you have, do `./manage.sh --help`.
#### 4. Serve the files
A folder `site` containing the static html pages will have been created. You can serve them from a server by pointing your server software (nginx, apache...) to this location. During development, you can run locally with
@ -48,4 +32,3 @@ A folder `site` containing the static html pages will have been created. You can
```
This handles setting up an http server and rebuilding when files change. You can then access the docs on <http://127.0.0.1:8000>