diff --git a/docs/changelog.md b/docs/changelog.md index 42333f1..786b75d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,11 +1 @@ -# Changelog - -Given a version number `MAJOR`.`MINOR`.`PATCH`: - -- `MAJOR` is updated when there are **incompatible changes**, -- `MINOR` is updated when there are **backwards-compatible feature additions**, -- `PATCH` is updated when there are **backwards-compatible bug fixes**. - -### 1.0.0 (date) - -- Basic features. +--8<-- "CHANGELOG.md" diff --git a/docs/deploy.md b/docs/deploy.md index a27e4b9..1d2c1b1 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -4,6 +4,7 @@ This page describes how the main instance is deployed, and is mainly meant as a way to share the knowledge. You can obviously do things differently. + See the [Getting Started](install.md) page for more information on selfhosting. ## Services diff --git a/docs/install.md b/docs/install.md index 32bf2dd..d62de81 100644 --- a/docs/install.md +++ b/docs/install.md @@ -32,13 +32,13 @@ pip install -e ".[dev]" And the frontend dependencies: -=== "Yarn" +=== "npm" ```bash npm install ``` -=== "npm" +=== "Yarn" ```bash yarn install ``` diff --git a/mkdocs.yml b/mkdocs.yml index 9c29b4b..fdc7844 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,3 +45,4 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true combine_header_slug: true + - pymdownx.snippets diff --git a/pyproject.toml b/pyproject.toml index ad899e2..045d12a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,9 @@ build-backend = "setuptools.build_meta" [project.optional-dependencies] dev = [ + "mkdocs>=1.6", + "mkdocs-material>=9.6", + "sendria>=2.2", "pytest>=7,<8", "pip-tools>=6,<7", "pytest-isort>=3,<4",