You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+20Lines changed: 20 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -26,3 +26,23 @@ Publish the draft release
26
26
If you're debugging a running server than `IO.inspect` is a good approach, any messages you create with it will be sent to your LSP client as a log message
27
27
28
28
To debug in tests you can use `IO.inspect(Process.whereis(:user), message, label: "message")` to send your output directly to the group leader of the test process.
29
+
30
+
# Documentation website
31
+
32
+
The documentation website is built using the [Mkdocs](https://www.mkdocs.org) static website generator. The content is written in Markdown format in the directory [docs](./docs) and is configured via the [mkdocs.yml](./mkdocs.yml) file.
33
+
34
+
## Development
35
+
36
+
Make sure you have a recent version of Python 3 and [Pip](https://pip.readthedocs.io/en/stable/installing/) installed.
37
+
38
+
Install `mkdocs` and the `material` theme with Pip:
39
+
40
+
```shell
41
+
pip install mkdocs mkdocs-material
42
+
```
43
+
44
+
Once installed, simply run `mkdocs serve` from the project root. This will start a local web server with a file watcher.
45
+
46
+
## Build
47
+
48
+
To compile the website for deployment, run `mkdocs build` from the project root. The built static assets will be located in the `site` directory. These can then be served by any web hosting solution.
0 commit comments