diff --git a/docs/_config.yml b/docs/_config.yml index 05807b2f1..a5baba764 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,7 +2,7 @@ title: Dendrite description: >- Second-generation Matrix homeserver written in Go! baseurl: "/dendrite" # the subpath of your site, e.g. /blog -url: "" +url: "https://matrix-org.github.io/dendrite/" twitter_username: matrixdotorg github_username: matrix-org remote_theme: just-the-docs/just-the-docs diff --git a/docs/INSTALL.md b/docs/installation.md similarity index 99% rename from docs/INSTALL.md rename to docs/installation.md index ca1316aca..d19358e1e 100644 --- a/docs/INSTALL.md +++ b/docs/installation.md @@ -1,3 +1,8 @@ +--- +title: Installation +has_children: true +--- + # Installing Dendrite Dendrite can be run in one of two configurations: @@ -50,11 +55,13 @@ cd dendrite Then build it: * Linux or UNIX-like systems: + ```bash ./build.sh ``` * Windows: + ```dos build.cmd ``` diff --git a/docs/installation/monolith.md b/docs/installation/monolith.md new file mode 100644 index 000000000..57bb165d9 --- /dev/null +++ b/docs/installation/monolith.md @@ -0,0 +1,6 @@ +--- +title: Monolith +parent: Installation +--- + +# Monolith installation diff --git a/docs/installation/polylith.md b/docs/installation/polylith.md new file mode 100644 index 000000000..05b75bc6c --- /dev/null +++ b/docs/installation/polylith.md @@ -0,0 +1,6 @@ +--- +title: Polylith +parent: Installation +--- + +# Polylith installation