README.md 2.31 KB
Newer Older
rinpatch's avatar
rinpatch committed
1 2
# Pleroma documentation

Ilja's avatar
Ilja committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
This project contains a documentation skeleton and a script to fill it in with data, the resulting documentation can be viewed at <https://docs-develop.pleroma.social>.

## Contributing to the documentation

If you want to suggest an edit, please refer to the `pleroma/pleroma` and `pleroma/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

rinpatch's avatar
rinpatch committed
21
#### 1. Install pipenv and dependencies
Ilja's avatar
Ilja committed
22 23

```shell
rinpatch's avatar
rinpatch committed
24 25
pip install pipenv
pipenv sync
Ilja's avatar
Ilja committed
26 27
```

rinpatch's avatar
rinpatch committed
28
#### 2. (Optional) Activate the virtual environment
Ilja's avatar
Ilja committed
29

rinpatch's avatar
rinpatch committed
30
Since dependencies are installed in a virtual environment, you can't use them directly. To use them you should either prefix the command with `pipenv run`, or activate the virtual environment for current shell by executing `pipenv shell` once.
Ilja's avatar
Ilja committed
31 32 33 34 35 36

#### 3. Build the docs using the script

```shell
git clone https://git.pleroma.social/pleroma/docs
cd docs
rinpatch's avatar
rinpatch committed
37
[pipenv run] ./manage.sh all
Ilja's avatar
Ilja committed
38 39 40 41 42 43 44 45 46
```

`./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

```shell
rinpatch's avatar
rinpatch committed
47
[pipenv run] mkdocs serve
Ilja's avatar
Ilja committed
48 49 50 51
```

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>