docs: New site 🎉
This commit is contained in:
Jade Ellis
parent
d45c5a9f47
commit
5ea1206739
58 changed files with 5918 additions and 1263 deletions
|
|
@ -26,29 +26,6 @@ jobs:
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Setup mdBook
|
|
||||||
uses: https://github.com/peaceiris/actions-mdbook@v2
|
|
||||||
with:
|
|
||||||
mdbook-version: "0.4.52"
|
|
||||||
|
|
||||||
- name: Build mdbook
|
|
||||||
run: mdbook build
|
|
||||||
|
|
||||||
- name: Prepare static files for deployment
|
|
||||||
run: |
|
|
||||||
mkdir -p ./public/.well-known/matrix
|
|
||||||
mkdir -p ./public/.well-known/continuwuity
|
|
||||||
mkdir -p ./public/schema
|
|
||||||
# Copy the Matrix .well-known files
|
|
||||||
cp ./docs/static/server ./public/.well-known/matrix/server
|
|
||||||
cp ./docs/static/client ./public/.well-known/matrix/client
|
|
||||||
cp ./docs/static/client ./public/.well-known/matrix/support
|
|
||||||
cp ./docs/static/announcements.json ./public/.well-known/continuwuity/announcements
|
|
||||||
cp ./docs/static/announcements.schema.json ./public/schema/announcements.schema.json
|
|
||||||
# Copy the custom headers file
|
|
||||||
cp ./docs/static/_headers ./public/_headers
|
|
||||||
echo "Copied .well-known files and _headers to ./public"
|
|
||||||
|
|
||||||
- name: Detect runner environment
|
- name: Detect runner environment
|
||||||
id: runner-env
|
id: runner-env
|
||||||
uses: https://git.tomfos.tr/actions/detect-versions@v1
|
uses: https://git.tomfos.tr/actions/detect-versions@v1
|
||||||
|
|
@ -63,9 +40,18 @@ jobs:
|
||||||
uses: actions/cache@v3
|
uses: actions/cache@v3
|
||||||
with:
|
with:
|
||||||
path: ~/.npm
|
path: ~/.npm
|
||||||
key: continuwuity-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-${{ steps.runner-env.outputs.node_version }}
|
key: continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-${{ steps.runner-env.outputs.node_version }}-${{ hashFiles('package-lock.json') }}
|
||||||
|
restore-keys: |
|
||||||
|
continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-${{ steps.runner-env.outputs.node_version }}-
|
||||||
|
continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build Rspress documentation
|
||||||
|
run: npm run docs:build
|
||||||
|
|
||||||
|
- name: Install Wrangler
|
||||||
run: npm install --save-dev wrangler@latest
|
run: npm install --save-dev wrangler@latest
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Production)
|
- name: Deploy to Cloudflare Pages (Production)
|
||||||
|
|
@ -74,7 +60,7 @@ jobs:
|
||||||
with:
|
with:
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||||
command: pages deploy ./public --branch="main" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
command: pages deploy ./doc_build --branch="main" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Preview)
|
- name: Deploy to Cloudflare Pages (Preview)
|
||||||
if: github.ref != 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
if: github.ref != 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
||||||
|
|
@ -82,4 +68,4 @@ jobs:
|
||||||
with:
|
with:
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||||
command: pages deploy ./public --branch="${{ github.head_ref || github.ref_name }}" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
command: pages deploy ./doc_build --branch="${{ github.head_ref || github.ref_name }}" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
||||||
|
|
|
||||||
9
.gitignore
vendored
9
.gitignore
vendored
|
|
@ -79,7 +79,7 @@ test-conduit.toml
|
||||||
/.gitlab-ci.d
|
/.gitlab-ci.d
|
||||||
|
|
||||||
# mdbook output
|
# mdbook output
|
||||||
public/
|
/public/
|
||||||
|
|
||||||
# macOS
|
# macOS
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
@ -95,3 +95,10 @@ rustc-ice-*
|
||||||
|
|
||||||
# complement test logs are huge
|
# complement test logs are huge
|
||||||
tests/test_results/complement/test_logs.jsonl
|
tests/test_results/complement/test_logs.jsonl
|
||||||
|
|
||||||
|
# Node
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# Rspress
|
||||||
|
doc_build/
|
||||||
|
.rspress/
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# Contributing guide
|
# Contributing guide
|
||||||
|
|
||||||
This page is about contributing to Continuwuity. The
|
This page is about contributing to Continuwuity. The
|
||||||
[development](./development.md) and [code style guide](./development/code_style.md) pages may be of interest for you as well.
|
[development](/development/index.mdx) and [code style guide](/development/code_style.mdx) pages may be of interest for you as well.
|
||||||
|
|
||||||
If you would like to work on an [issue][issues] that is not assigned, preferably
|
If you would like to work on an [issue][issues] that is not assigned, preferably
|
||||||
ask in the Matrix room first at [#continuwuity:continuwuity.org][continuwuity-matrix],
|
ask in the Matrix room first at [#continuwuity:continuwuity.org][continuwuity-matrix],
|
||||||
|
|
@ -9,7 +9,7 @@ and comment on it.
|
||||||
|
|
||||||
### Code Style
|
### Code Style
|
||||||
|
|
||||||
Please review and follow the [code style guide](./development/code_style.md) for formatting, linting, naming conventions, and other code standards.
|
Please review and follow the [code style guide](/development/code_style.mdx) for formatting, linting, naming conventions, and other code standards.
|
||||||
|
|
||||||
### Pre-commit Checks
|
### Pre-commit Checks
|
||||||
|
|
||||||
|
|
@ -150,7 +150,7 @@ of it, especially when the CI completed successfully and everything so it
|
||||||
|
|
||||||
Before submitting a pull request, please ensure:
|
Before submitting a pull request, please ensure:
|
||||||
1. Your code passes all CI checks (formatting, linting, typo detection, etc.)
|
1. Your code passes all CI checks (formatting, linting, typo detection, etc.)
|
||||||
2. Your code follows the [code style guide](./development/code_style.md)
|
2. Your code follows the [code style guide](/development/code_style.md)
|
||||||
3. Your commit messages follow the conventional commits format
|
3. Your commit messages follow the conventional commits format
|
||||||
4. Tests are added for new functionality
|
4. Tests are added for new functionality
|
||||||
5. Documentation is updated if needed
|
5. Documentation is updated if needed
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@ We appreciate the efforts of security researchers and the community in identifyi
|
||||||
|
|
||||||
1. **Contact members of the team directly** over E2EE private message.
|
1. **Contact members of the team directly** over E2EE private message.
|
||||||
- [@jade:ellis.link](https://matrix.to/#/@jade:ellis.link)
|
- [@jade:ellis.link](https://matrix.to/#/@jade:ellis.link)
|
||||||
- [@nex:nexy7574.co.uk](https://matrix.to/#/@nex:nexy7574.co.uk) <!-- ? -->
|
- [@nex:nexy7574.co.uk](https://matrix.to/#/@nex:nexy7574.co.uk)
|
||||||
2. **Email the security team** at [security@continuwuity.org](mailto:security@continuwuity.org). This is not E2EE, so don't include sensitive details.
|
2. **Email the security team** at [security@continuwuity.org](mailto:security@continuwuity.org). This is not E2EE, so don't include sensitive details.
|
||||||
3. **Do not disclose the vulnerability publicly** until it has been addressed
|
3. **Do not disclose the vulnerability publicly** until it has been addressed
|
||||||
4. **Provide detailed information** about the vulnerability, including:
|
4. **Provide detailed information** about the vulnerability, including:
|
||||||
|
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
# Summary
|
|
||||||
|
|
||||||
- [Introduction](introduction.md)
|
|
||||||
- [Configuration](configuration.md)
|
|
||||||
- [Examples](configuration/examples.md)
|
|
||||||
- [Deploying](deploying.md)
|
|
||||||
- [Generic](deploying/generic.md)
|
|
||||||
- [NixOS](deploying/nixos.md)
|
|
||||||
- [Docker](deploying/docker.md)
|
|
||||||
- [Kubernetes](deploying/kubernetes.md)
|
|
||||||
- [Arch Linux](deploying/arch-linux.md)
|
|
||||||
- [Debian](deploying/debian.md)
|
|
||||||
- [Fedora](deploying/fedora.md)
|
|
||||||
- [FreeBSD](deploying/freebsd.md)
|
|
||||||
- [TURN](turn.md)
|
|
||||||
- [Appservices](appservices.md)
|
|
||||||
- [Maintenance](maintenance.md)
|
|
||||||
- [Troubleshooting](troubleshooting.md)
|
|
||||||
- [Admin Command Reference](admin_reference.md)
|
|
||||||
- [Development](development.md)
|
|
||||||
- [Contributing](contributing.md)
|
|
||||||
- [Code Style Guide](development/code_style.md)
|
|
||||||
- [Testing](development/testing.md)
|
|
||||||
- [Hot Reloading ("Live" Development)](development/hot_reload.md)
|
|
||||||
- [Community (and Guidelines)](community.md)
|
|
||||||
- [Security](security.md)
|
|
||||||
74
docs/_meta.json
Normal file
74
docs/_meta.json
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "introduction",
|
||||||
|
"label": "Continuwuity"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "configuration",
|
||||||
|
"label": "Configuration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "dir",
|
||||||
|
"name": "deploying",
|
||||||
|
"label": "Deploying"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "turn",
|
||||||
|
"label": "TURN"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "appservices",
|
||||||
|
"label": "Appservices"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "maintenance",
|
||||||
|
"label": "Maintenance"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "troubleshooting",
|
||||||
|
"label": "Troubleshooting"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "divider"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "dir-section-header",
|
||||||
|
"name": "development",
|
||||||
|
"label": "Development",
|
||||||
|
"collapsible": true,
|
||||||
|
"collapsed": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "divider"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "section-header",
|
||||||
|
"label": "Reference"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"label": "Configuration Reference",
|
||||||
|
"name": "/reference/config"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"label": "Admin Command Reference",
|
||||||
|
"name": "/reference/admin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"label": "Server Reference",
|
||||||
|
"name": "/reference/server"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "divider"
|
||||||
|
},
|
||||||
|
"community",
|
||||||
|
"security"
|
||||||
|
]
|
||||||
37
docs/_nav.json
Normal file
37
docs/_nav.json
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"text": "Guide",
|
||||||
|
"link": "/introduction",
|
||||||
|
"activeMatch": "^/(introduction|configuration|deploying|turn|appservices|maintenance|troubleshooting)"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Development",
|
||||||
|
"link": "/development/index",
|
||||||
|
"activeMatch": "^/development/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Reference",
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"text": "Configuration Reference",
|
||||||
|
"link": "/reference/config"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Admin Command Reference",
|
||||||
|
"link": "/reference/admin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Server Reference",
|
||||||
|
"link": "/reference/server"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Community",
|
||||||
|
"link": "/community"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "Security",
|
||||||
|
"link": "/security"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
@ -10,7 +10,7 @@ community channels that reference them. We've written these guidelines to help u
|
||||||
environment where everyone feels safe and respected.
|
environment where everyone feels safe and respected.
|
||||||
|
|
||||||
For code and contribution guidelines, please refer to the
|
For code and contribution guidelines, please refer to the
|
||||||
[Contributor's Covenant](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CODE_OF_CONDUCT.md).
|
[Contributor's Covenant](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CODE_OF_CONDUCT.mdx).
|
||||||
Below are additional guidelines specific to the Continuwuity community.
|
Below are additional guidelines specific to the Continuwuity community.
|
||||||
|
|
||||||
## Our Values and Expected Behaviors
|
## Our Values and Expected Behaviors
|
||||||
|
|
@ -8,7 +8,7 @@ Continuwuity uses a config file for the majority of the settings, but also suppo
|
||||||
setting individual config options via commandline.
|
setting individual config options via commandline.
|
||||||
|
|
||||||
Please refer to the [example config
|
Please refer to the [example config
|
||||||
file](./configuration/examples.md#example-configuration) for all of those
|
file](./reference/config.mdx) for all of those
|
||||||
settings.
|
settings.
|
||||||
|
|
||||||
The config file to use can be specified on the commandline when running
|
The config file to use can be specified on the commandline when running
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
## Example configuration
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Example configuration</summary>
|
|
||||||
|
|
||||||
```toml
|
|
||||||
{{#include ../../conduwuit-example.toml}}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## systemd unit file
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>systemd unit file</summary>
|
|
||||||
|
|
||||||
```
|
|
||||||
{{#include ../../pkg/conduwuit.service}}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
42
docs/deploying/_meta.json
Normal file
42
docs/deploying/_meta.json
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "generic",
|
||||||
|
"label": "Generic"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "docker",
|
||||||
|
"label": "Docker"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "debian",
|
||||||
|
"label": "Debian"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "fedora",
|
||||||
|
"label": "Fedora"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "nixos",
|
||||||
|
"label": "NixOS"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "arch-linux",
|
||||||
|
"label": "Arch Linux"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "kubernetes",
|
||||||
|
"label": "Kubernetes"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "freebsd",
|
||||||
|
"label": "FreeBSD"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
{{#include ../../pkg/debian/README.md}}
|
|
||||||
1
docs/deploying/debian.mdx
Symbolic link
1
docs/deploying/debian.mdx
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../../pkg/debian/README.md
|
||||||
|
|
@ -40,10 +40,10 @@ or you can use [Docker Compose](#docker-compose).
|
||||||
|
|
||||||
The `-d` flag lets the container run in detached mode. You may supply an
|
The `-d` flag lets the container run in detached mode. You may supply an
|
||||||
optional `continuwuity.toml` config file, the example config can be found
|
optional `continuwuity.toml` config file, the example config can be found
|
||||||
[here](../configuration/examples.md). You can pass in different env vars to
|
[here](../reference/config.mdx). You can pass in different env vars to
|
||||||
change config values on the fly. You can even configure Continuwuity completely by
|
change config values on the fly. You can even configure Continuwuity completely by
|
||||||
using env vars. For an overview of possible values, please take a look at the
|
using env vars. For an overview of possible values, please take a look at the
|
||||||
[`docker-compose.yml`](docker-compose.yml) file.
|
<a href="/examples/docker-compose.yml" target="_blank">`docker-compose.yml`</a> file.
|
||||||
|
|
||||||
If you just want to test Continuwuity for a short time, you can use the `--rm`
|
If you just want to test Continuwuity for a short time, you can use the `--rm`
|
||||||
flag, which cleans up everything related to your container after you stop
|
flag, which cleans up everything related to your container after you stop
|
||||||
|
|
@ -56,14 +56,62 @@ of the provided `docker-compose` files.
|
||||||
|
|
||||||
Depending on your proxy setup, you can use one of the following files:
|
Depending on your proxy setup, you can use one of the following files:
|
||||||
|
|
||||||
- If you already have a `traefik` instance set up, use
|
### For existing Traefik setup
|
||||||
[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
|
|
||||||
- If you don't have a `traefik` instance set up and would like to use it, use
|
<details>
|
||||||
[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
|
<summary>docker-compose.for-traefik.yml</summary>
|
||||||
- If you want a setup that works out of the box with `caddy-docker-proxy`, use
|
|
||||||
[`docker-compose.with-caddy.yml`](docker-compose.with-caddy.yml) and replace all
|
```yaml file="./docker-compose.for-traefik.yml"
|
||||||
`example.com` placeholders with your own domain
|
|
||||||
- For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### With Traefik included
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>docker-compose.with-traefik.yml</summary>
|
||||||
|
|
||||||
|
```yaml file="./docker-compose.with-traefik.yml"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### With Caddy Docker Proxy
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>docker-compose.with-caddy.yml</summary>
|
||||||
|
|
||||||
|
Replace all `example.com` placeholders with your own domain.
|
||||||
|
|
||||||
|
```yaml file="./docker-compose.with-caddy.yml"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### For other reverse proxies
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>docker-compose.yml</summary>
|
||||||
|
|
||||||
|
```yaml file="./docker-compose.yml"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### Override file
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>docker-compose.override.yml</summary>
|
||||||
|
|
||||||
|
```yaml file="./docker-compose.override.yml"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
When picking the Traefik-related compose file, rename it to
|
When picking the Traefik-related compose file, rename it to
|
||||||
`docker-compose.yml`, and rename the override file to
|
`docker-compose.yml`, and rename the override file to
|
||||||
|
|
@ -80,7 +128,7 @@ docker network create caddy
|
||||||
After that, you can rename it to `docker-compose.yml` and spin up the
|
After that, you can rename it to `docker-compose.yml` and spin up the
|
||||||
containers!
|
containers!
|
||||||
|
|
||||||
Additional info about deploying Continuwuity can be found [here](generic.md).
|
Additional info about deploying Continuwuity can be found [here](generic.mdx).
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
|
|
@ -88,7 +136,18 @@ Official Continuwuity images are built using **Docker Buildx** and the Dockerfil
|
||||||
|
|
||||||
The resulting images are widely compatible with Docker and other container runtimes like Podman or containerd.
|
The resulting images are widely compatible with Docker and other container runtimes like Podman or containerd.
|
||||||
|
|
||||||
The images *do not contain a shell*. They contain only the Continuwuity binary, required libraries, TLS certificates, and metadata. Please refer to the [`docker/Dockerfile`][dockerfile-path] for the specific details of the image composition.
|
The images *do not contain a shell*. They contain only the Continuwuity binary, required libraries, TLS certificates, and metadata.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to view the Dockerfile</summary>
|
||||||
|
|
||||||
|
You can also <a href="https://forgejo.ellis.link/continuwuation/continuwuation/src/branch/main/docker/Dockerfile" target="_blank">view the Dockerfile on Forgejo</a>.
|
||||||
|
|
||||||
|
```dockerfile file="../../docker/Dockerfile"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
To build an image locally using Docker Buildx, you can typically run a command like:
|
To build an image locally using Docker Buildx, you can typically run a command like:
|
||||||
|
|
||||||
|
|
@ -105,7 +164,7 @@ docker buildx build --load --tag continuwuity:latest -f docker/Dockerfile .
|
||||||
|
|
||||||
Refer to the Docker Buildx documentation for more advanced build options.
|
Refer to the Docker Buildx documentation for more advanced build options.
|
||||||
|
|
||||||
[dockerfile-path]: ../../docker/Dockerfile
|
[dockerfile-path]: https://forgejo.ellis.link/continuwuation/continuwuation/src/branch/main/docker/Dockerfile
|
||||||
|
|
||||||
### Run
|
### Run
|
||||||
|
|
||||||
|
|
@ -123,10 +182,7 @@ docker compose up -d
|
||||||
|
|
||||||
As a container user, you probably know about Traefik. It is an easy-to-use
|
As a container user, you probably know about Traefik. It is an easy-to-use
|
||||||
reverse proxy for making containerized apps and services available through the
|
reverse proxy for making containerized apps and services available through the
|
||||||
web. With the two provided files,
|
web. With the Traefik-related docker-compose files provided above, it is equally easy
|
||||||
[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
|
|
||||||
[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
|
|
||||||
[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
|
|
||||||
to deploy and use Continuwuity, with a small caveat. If you have already looked at
|
to deploy and use Continuwuity, with a small caveat. If you have already looked at
|
||||||
the files, you should have seen the `well-known` service, which is the
|
the files, you should have seen the `well-known` service, which is the
|
||||||
small caveat. Traefik is simply a proxy and load balancer and cannot
|
small caveat. Traefik is simply a proxy and load balancer and cannot
|
||||||
|
|
@ -97,8 +97,7 @@ on the network level, consider something like NextDNS or Pi-Hole.
|
||||||
|
|
||||||
## Setting up a systemd service
|
## Setting up a systemd service
|
||||||
|
|
||||||
You can find two example systemd units for Continuwuity
|
You can find an example unit for continuwuity below.
|
||||||
[on the configuration page](../configuration/examples.md#debian-systemd-unit-file).
|
|
||||||
You may need to change the `ExecStart=` path to match where you placed the Continuwuity
|
You may need to change the `ExecStart=` path to match where you placed the Continuwuity
|
||||||
binary if it is not in `/usr/bin/conduwuit`.
|
binary if it is not in `/usr/bin/conduwuit`.
|
||||||
|
|
||||||
|
|
@ -117,11 +116,26 @@ and entering the following:
|
||||||
ReadWritePaths=/path/to/custom/database/path
|
ReadWritePaths=/path/to/custom/database/path
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Example systemd Unit File
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to expand systemd unit file (conduwuit.service)</summary>
|
||||||
|
|
||||||
|
|
||||||
|
```ini file="../../pkg/conduwuit.service"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
You can also [view the file on Foregejo](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/pkg/conduwuit.service).
|
||||||
|
|
||||||
## Creating the Continuwuity configuration file
|
## Creating the Continuwuity configuration file
|
||||||
|
|
||||||
Now you need to create the Continuwuity configuration file in
|
Now you need to create the Continuwuity configuration file in
|
||||||
`/etc/continuwuity/continuwuity.toml`. You can find an example configuration at
|
`/etc/continuwuity/continuwuity.toml`. You can find an example configuration at
|
||||||
[conduwuit-example.toml](../configuration/examples.md).
|
[conduwuit-example.toml](../reference/config.mdx).
|
||||||
|
|
||||||
**Please take a moment to read the config. You need to change at least the
|
**Please take a moment to read the config. You need to change at least the
|
||||||
server name.**
|
server name.**
|
||||||
|
|
@ -156,7 +170,7 @@ For other software, please refer to their respective documentation or online gui
|
||||||
After installing Caddy via your preferred method, create `/etc/caddy/conf.d/conduwuit_caddyfile`
|
After installing Caddy via your preferred method, create `/etc/caddy/conf.d/conduwuit_caddyfile`
|
||||||
and enter the following (substitute your actual server name):
|
and enter the following (substitute your actual server name):
|
||||||
|
|
||||||
```caddyfile
|
```
|
||||||
your.server.name, your.server.name:8448 {
|
your.server.name, your.server.name:8448 {
|
||||||
# TCP reverse_proxy
|
# TCP reverse_proxy
|
||||||
reverse_proxy 127.0.0.1:6167
|
reverse_proxy 127.0.0.1:6167
|
||||||
|
|
@ -193,8 +207,10 @@ See the following spec pages for more details on these files:
|
||||||
- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport)
|
- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport)
|
||||||
|
|
||||||
Examples of delegation:
|
Examples of delegation:
|
||||||
- <https://puppygock.gay/.well-known/matrix/server>
|
- https://continuwuity.org/.well-known/matrix/server
|
||||||
- <https://puppygock.gay/.well-known/matrix/client>
|
- https://continuwuity.org/.well-known/matrix/client
|
||||||
|
- https://ellis.link/.well-known/matrix/server
|
||||||
|
- https://ellis.link/.well-known/matrix/client
|
||||||
|
|
||||||
For Apache and Nginx there are many examples available online.
|
For Apache and Nginx there are many examples available online.
|
||||||
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
# Continuwuity for Kubernetes
|
# Continuwuity for Kubernetes
|
||||||
|
|
||||||
Continuwuity doesn't support horizontal scalability or distributed loading
|
Continuwuity doesn't support horizontal scalability or distributed loading
|
||||||
natively. However, a community-maintained Helm Chart is available here to run
|
natively. However, [a community-maintained Helm Chart is available here to run
|
||||||
conduwuit on Kubernetes: <https://gitlab.cronce.io/charts/conduwuit>
|
conduwuit on Kubernetes](https://gitlab.cronce.io/charts/conduwuit)
|
||||||
|
|
||||||
This should be compatible with Continuwuity, but you will need to change the image reference.
|
This should be compatible with Continuwuity, but you will need to change the image reference.
|
||||||
|
|
||||||
|
|
@ -48,7 +48,7 @@ The NixOS module provides these configuration options:
|
||||||
- `package`: The Continuwuity package to use
|
- `package`: The Continuwuity package to use
|
||||||
- `settings`: The Continuwuity configuration (in TOML format)
|
- `settings`: The Continuwuity configuration (in TOML format)
|
||||||
|
|
||||||
Use the `settings` option to configure Continuwuity itself. See the [example configuration file](../configuration/examples.md#example-configuration) for all available options.
|
Use the `settings` option to configure Continuwuity itself. See the [example configuration file](../reference/config.mdx) for all available options.
|
||||||
|
|
||||||
### UNIX sockets
|
### UNIX sockets
|
||||||
|
|
||||||
27
docs/development/_meta.json
Normal file
27
docs/development/_meta.json
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "index",
|
||||||
|
"label": "Development Guide"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "contributing",
|
||||||
|
"label": "Contributing"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "code_style",
|
||||||
|
"label": "Code Style Guide"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "testing",
|
||||||
|
"label": "Testing"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "hot_reload",
|
||||||
|
"label": "Hot Reloading"
|
||||||
|
}
|
||||||
|
]
|
||||||
173
docs/development/contributing.mdx
Normal file
173
docs/development/contributing.mdx
Normal file
|
|
@ -0,0 +1,173 @@
|
||||||
|
# Contributing guide
|
||||||
|
|
||||||
|
This page is about contributing to Continuwuity. The
|
||||||
|
[development](./index.mdx) and [code style guide](./code_style.mdx) pages may be of interest for you as well.
|
||||||
|
|
||||||
|
If you would like to work on an [issue][issues] that is not assigned, preferably
|
||||||
|
ask in the Matrix room first at [#continuwuity:continuwuity.org][continuwuity-matrix],
|
||||||
|
and comment on it.
|
||||||
|
|
||||||
|
### Code Style
|
||||||
|
|
||||||
|
Please review and follow the [code style guide](./code_style) for formatting, linting, naming conventions, and other code standards.
|
||||||
|
|
||||||
|
### Pre-commit Checks
|
||||||
|
|
||||||
|
Continuwuity uses pre-commit hooks to enforce various coding standards and catch common issues before they're committed. These checks include:
|
||||||
|
|
||||||
|
- Code formatting and linting
|
||||||
|
- Typo detection (both in code and commit messages)
|
||||||
|
- Checking for large files
|
||||||
|
- Ensuring proper line endings and no trailing whitespace
|
||||||
|
- Validating YAML, JSON, and TOML files
|
||||||
|
- Checking for merge conflicts
|
||||||
|
|
||||||
|
You can run these checks locally by installing [prefligit](https://github.com/j178/prefligit):
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Requires UV: https://docs.astral.sh/uv/getting-started/installation/
|
||||||
|
# Mac/linux: curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||||
|
# Windows: powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
|
||||||
|
|
||||||
|
# Install prefligit using cargo-binstall
|
||||||
|
cargo binstall prefligit
|
||||||
|
|
||||||
|
# Install git hooks to run checks automatically
|
||||||
|
prefligit install
|
||||||
|
|
||||||
|
# Run all checks
|
||||||
|
prefligit --all-files
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, you can use [pre-commit](https://pre-commit.com/):
|
||||||
|
```bash
|
||||||
|
# Requires python
|
||||||
|
|
||||||
|
# Install pre-commit
|
||||||
|
pip install pre-commit
|
||||||
|
|
||||||
|
# Install the hooks
|
||||||
|
pre-commit install
|
||||||
|
|
||||||
|
# Run all checks manually
|
||||||
|
pre-commit run --all-files
|
||||||
|
```
|
||||||
|
|
||||||
|
These same checks are run in CI via the prefligit-checks workflow to ensure consistency. These must pass before the PR is merged.
|
||||||
|
|
||||||
|
### Running tests locally
|
||||||
|
|
||||||
|
Tests, compilation, and linting can be run with standard Cargo commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run tests
|
||||||
|
cargo test
|
||||||
|
|
||||||
|
# Check compilation
|
||||||
|
cargo check --workspace --features full
|
||||||
|
|
||||||
|
# Run lints
|
||||||
|
cargo clippy --workspace --features full
|
||||||
|
# Auto-fix: cargo clippy --workspace --features full --fix --allow-staged;
|
||||||
|
|
||||||
|
# Format code (must use nightly)
|
||||||
|
cargo +nightly fmt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Matrix tests
|
||||||
|
|
||||||
|
Continuwuity uses [Complement][complement] for Matrix protocol compliance testing. Complement tests are run manually by developers, and documentation on how to run these tests locally is currently being developed.
|
||||||
|
|
||||||
|
If your changes are done to fix Matrix tests, please note that in your pull request. If more Complement tests start failing from your changes, please review the logs and determine if they're intended or not.
|
||||||
|
|
||||||
|
[Sytest][sytest] is currently unsupported.
|
||||||
|
|
||||||
|
### Writing documentation
|
||||||
|
|
||||||
|
Continuwuity's website uses [`mdbook`][mdbook] and is deployed via CI using Cloudflare Pages
|
||||||
|
in the [`documentation.yml`][documentation.yml] workflow file. All documentation is in the `docs/`
|
||||||
|
directory at the top level.
|
||||||
|
|
||||||
|
To build the documentation locally:
|
||||||
|
|
||||||
|
1. Install mdbook if you don't have it already:
|
||||||
|
```bash
|
||||||
|
cargo install mdbook # or cargo binstall, or another method
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Build the documentation:
|
||||||
|
```bash
|
||||||
|
mdbook build
|
||||||
|
```
|
||||||
|
|
||||||
|
The output of the mdbook generation is in `public/`. You can open the HTML files directly in your browser without needing a web server.
|
||||||
|
|
||||||
|
|
||||||
|
### Commit Messages
|
||||||
|
|
||||||
|
Continuwuity follows the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This provides a standardized format that makes the commit history more readable and enables automated tools to generate changelogs.
|
||||||
|
|
||||||
|
The basic structure is:
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>[(optional scope)]: <description>
|
||||||
|
|
||||||
|
[optional body]
|
||||||
|
|
||||||
|
[optional footer(s)]
|
||||||
|
```
|
||||||
|
|
||||||
|
The allowed types for commits are:
|
||||||
|
- `fix`: Bug fixes
|
||||||
|
- `feat`: New features
|
||||||
|
- `docs`: Documentation changes
|
||||||
|
- `style`: Changes that don't affect the meaning of the code (formatting, etc.)
|
||||||
|
- `refactor`: Code changes that neither fix bugs nor add features
|
||||||
|
- `perf`: Performance improvements
|
||||||
|
- `test`: Adding or fixing tests
|
||||||
|
- `build`: Changes to the build system or dependencies
|
||||||
|
- `ci`: Changes to CI configuration
|
||||||
|
- `chore`: Other changes that don't modify source or test files
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
```
|
||||||
|
feat: add user authentication
|
||||||
|
fix(database): resolve connection pooling issue
|
||||||
|
docs: update installation instructions
|
||||||
|
```
|
||||||
|
|
||||||
|
The project uses the `committed` hook to validate commit messages in pre-commit. This ensures all commits follow the conventional format.
|
||||||
|
|
||||||
|
### Creating pull requests
|
||||||
|
|
||||||
|
Please try to keep contributions to the Forgejo Instance. While the mirrors of continuwuity
|
||||||
|
allow for pull/merge requests, there is no guarantee the maintainers will see them in a timely
|
||||||
|
manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts.
|
||||||
|
This prevents us from having to ping once in a while to double check the status
|
||||||
|
of it, especially when the CI completed successfully and everything so it
|
||||||
|
*looks* done.
|
||||||
|
|
||||||
|
Before submitting a pull request, please ensure:
|
||||||
|
1. Your code passes all CI checks (formatting, linting, typo detection, etc.)
|
||||||
|
2. Your code follows the [code style guide](./code_style)
|
||||||
|
3. Your commit messages follow the conventional commits format
|
||||||
|
4. Tests are added for new functionality
|
||||||
|
5. Documentation is updated if needed
|
||||||
|
|
||||||
|
Direct all PRs/MRs to the `main` branch.
|
||||||
|
|
||||||
|
By sending a pull request or patch, you are agreeing that your changes are
|
||||||
|
allowed to be licenced under the Apache-2.0 licence and all of your conduct is
|
||||||
|
in line with the Contributor's Covenant, and continuwuity's Code of Conduct.
|
||||||
|
|
||||||
|
Contribution by users who violate either of these code of conducts may not have
|
||||||
|
their contributions accepted. This includes users who have been banned from
|
||||||
|
continuwuity Matrix rooms for Code of Conduct violations.
|
||||||
|
|
||||||
|
[issues]: https://forgejo.ellis.link/continuwuation/continuwuity/issues
|
||||||
|
[continuwuity-matrix]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||||
|
[complement]: https://github.com/matrix-org/complement/
|
||||||
|
[sytest]: https://github.com/matrix-org/sytest/
|
||||||
|
[mdbook]: https://rust-lang.github.io/mdBook/
|
||||||
|
[documentation.yml]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/.forgejo/workflows/documentation.yml
|
||||||
|
|
@ -137,7 +137,7 @@ acyclic graph. The primary rule is simple and illustrated in the figure below:
|
||||||
it.**
|
it.**
|
||||||
|
|
||||||
|
Volk](./assets/libraries.png)
|
||||||
|
|
||||||
When a symbol is referenced between crates they become bound: **crates cannot be
|
When a symbol is referenced between crates they become bound: **crates cannot be
|
||||||
unloaded until their calling crates are first unloaded.** Thus we start the
|
unloaded until their calling crates are first unloaded.** Thus we start the
|
||||||
|
|
@ -148,7 +148,7 @@ and the first crate, freeing the executable from all modules as no global
|
||||||
binding ever occurs between them.
|
binding ever occurs between them.
|
||||||
|
|
||||||
|
Volk](./assets/reload_order.png)
|
||||||
|
|
||||||
Proper resource management is essential for reliable reloading to occur. This is
|
Proper resource management is essential for reliable reloading to occur. This is
|
||||||
a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is
|
a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Information about developing the project. If you are only interested in using
|
Information about developing the project. If you are only interested in using
|
||||||
it, you can safely ignore this page. If you plan on contributing, see the
|
it, you can safely ignore this page. If you plan on contributing, see the
|
||||||
[contributor's guide](./contributing.md) and [code style guide](./development/code_style.md).
|
[contributor's guide](./contributing.mdx) and [code style guide](./code_style.mdx).
|
||||||
|
|
||||||
## Continuwuity project layout
|
## Continuwuity project layout
|
||||||
|
|
||||||
|
|
@ -24,7 +24,7 @@ and run the script.
|
||||||
If you're on macOS and need to build an image, run `nix build .#linux-complement`.
|
If you're on macOS and need to build an image, run `nix build .#linux-complement`.
|
||||||
|
|
||||||
We have a Complement fork as some tests have needed to be fixed. This can be found
|
We have a Complement fork as some tests have needed to be fixed. This can be found
|
||||||
at: <https://forgejo.ellis.link/continuwuation/complement>
|
at [continuwuation/complement](https://forgejo.ellis.link/continuwuation/complement)
|
||||||
|
|
||||||
[ci-workflows]:
|
[ci-workflows]:
|
||||||
https://forgejo.ellis.link/continuwuation/continuwuity/actions/?workflow=ci.yml&actor=0&status=1
|
https://forgejo.ellis.link/continuwuation/continuwuity/actions/?workflow=ci.yml&actor=0&status=1
|
||||||
59
docs/index.mdx
Normal file
59
docs/index.mdx
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
---
|
||||||
|
pageType: home
|
||||||
|
|
||||||
|
hero:
|
||||||
|
name: Continuwuity
|
||||||
|
text: A community-driven Matrix homeserver
|
||||||
|
tagline: Fast, lightweight, and written in Rust
|
||||||
|
actions:
|
||||||
|
- theme: brand
|
||||||
|
text: Get Started
|
||||||
|
link: /introduction
|
||||||
|
- theme: alt
|
||||||
|
text: View on GitHub
|
||||||
|
link: https://github.com/continuwuity/continuwuity
|
||||||
|
image:
|
||||||
|
src: /assets/logo.svg
|
||||||
|
alt: continuwuity logo
|
||||||
|
|
||||||
|
features:
|
||||||
|
- title: 🚀 High Performance
|
||||||
|
details: Built with Rust for exceptional speed and efficiency. Designed to run smoothly even on modest hardware.
|
||||||
|
- title: 🔒 Secure by Default
|
||||||
|
details: Memory-safe Rust implementation with built-in security features to protect your communication.
|
||||||
|
- title: 🌐 Matrix Protocol
|
||||||
|
details: Fully compatible with the Matrix ecosystem. Connect with users across the federated network.
|
||||||
|
- title: 🛠️ Community Maintained
|
||||||
|
details: Actively developed by a dedicated community of Matrix enthusiasts and contributors.
|
||||||
|
- title: 📦 Easy to Deploy
|
||||||
|
details: Multiple deployment options including Docker, NixOS, and traditional package managers.
|
||||||
|
- title: 🔌 Appservice Support
|
||||||
|
details: Bridge to other platforms like Discord, Telegram, and more with Matrix appservices.
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why continuwuity?
|
||||||
|
|
||||||
|
continuwuity is the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver. When the original project was archived, we forked it to ensure this excellent Rust-based Matrix homeserver continues to thrive.
|
||||||
|
|
||||||
|
### Our Goals
|
||||||
|
|
||||||
|
- **Maintain stability**: Provide a reliable Matrix homeserver implementation
|
||||||
|
- **Improve compatibility**: Better Matrix specification compliance
|
||||||
|
- **Fix issues**: Address bugs and performance problems from the original
|
||||||
|
- **Add features**: Implement missing capabilities requested by administrators
|
||||||
|
- **Document thoroughly**: Comprehensive guides for setup and maintenance
|
||||||
|
- **Foster community**: Create a sustainable, welcoming development environment
|
||||||
|
|
||||||
|
## Quick Links
|
||||||
|
|
||||||
|
- **[Introduction](/introduction)** - Learn more about the project
|
||||||
|
- **[Deploying](/deploying)** - Get started with installation
|
||||||
|
- **[Configuration](/configuration)** - Configure your homeserver
|
||||||
|
- **[Contributing](/development/contributing)** - Help improve continuwuity
|
||||||
|
|
||||||
|
## Join the Community
|
||||||
|
|
||||||
|
Have questions or want to contribute? Join us on Matrix!
|
||||||
|
|
||||||
|
- **Main Room**: [#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
||||||
|
- **Space**: [#space:continuwuity.org](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# Continuwuity
|
|
||||||
|
|
||||||
{{#include ../README.md:catchphrase}}
|
|
||||||
|
|
||||||
{{#include ../README.md:body}}
|
|
||||||
|
|
||||||
#### How can I deploy my own?
|
|
||||||
|
|
||||||
- [Deployment options](deploying.md)
|
|
||||||
|
|
||||||
If you want to connect an appservice to Continuwuity, take a look at the
|
|
||||||
[appservices documentation](appservices.md).
|
|
||||||
|
|
||||||
#### How can I contribute?
|
|
||||||
|
|
||||||
See the [contributor's guide](contributing.md)
|
|
||||||
|
|
||||||
{{#include ../README.md:footer}}
|
|
||||||
92
docs/introduction.mdx
Normal file
92
docs/introduction.mdx
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
# continuwuity
|
||||||
|
|
||||||
|
## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
|
||||||
|
|
||||||
|
[](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) [](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
||||||
|
|
||||||
|
[continuwuity] is a Matrix homeserver written in Rust.
|
||||||
|
It's the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver.
|
||||||
|
|
||||||
|
[](https://forgejo.ellis.link/continuwuation/continuwuity) [](https://forgejo.ellis.link/continuwuation/continuwuity/stars) [](https://forgejo.ellis.link/continuwuation/continuwuity/issues?state=open) [](https://forgejo.ellis.link/continuwuation/continuwuity/pulls?state=open)
|
||||||
|
|
||||||
|
[](https://github.com/continuwuity/continuwuity) [](https://github.com/continuwuity/continuwuity/stargazers)
|
||||||
|
|
||||||
|
[](https://gitlab.com/continuwuity/continuwuity) [](https://gitlab.com/continuwuity/continuwuity/-/starrers)
|
||||||
|
|
||||||
|
[](https://codeberg.org/continuwuity/continuwuity) [](https://codeberg.org/continuwuity/continuwuity/stars)
|
||||||
|
|
||||||
|
## Why does this exist?
|
||||||
|
|
||||||
|
The original conduwuit project has been archived and is no longer maintained. Rather than letting this Rust-based Matrix homeserver disappear, a group of community contributors have forked the project to continue its development, fix outstanding issues, and add new features.
|
||||||
|
|
||||||
|
We aim to provide a stable, well-maintained alternative for current conduwuit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver.
|
||||||
|
|
||||||
|
## Who are we?
|
||||||
|
|
||||||
|
We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
|
||||||
|
contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
|
||||||
|
|
||||||
|
We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
|
||||||
|
|
||||||
|
## What is Matrix?
|
||||||
|
|
||||||
|
[Matrix](https://matrix.org) is an open, federated, and extensible network for
|
||||||
|
decentralized communication. Users from any Matrix homeserver can chat with users from all
|
||||||
|
other homeservers over federation. Matrix is designed to be extensible and built on top of.
|
||||||
|
You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord.
|
||||||
|
|
||||||
|
## What are the project's goals?
|
||||||
|
|
||||||
|
continuwuity aims to:
|
||||||
|
|
||||||
|
- Maintain a stable, reliable Matrix homeserver implementation in Rust
|
||||||
|
- Improve compatibility and specification compliance with the Matrix protocol
|
||||||
|
- Fix bugs and performance issues from the original conduwuit
|
||||||
|
- Add missing features needed by homeserver administrators
|
||||||
|
- Provide comprehensive documentation and easy deployment options
|
||||||
|
- Create a sustainable development model for long-term maintenance
|
||||||
|
- Keep a lightweight, efficient codebase that can run on modest hardware
|
||||||
|
|
||||||
|
## Can I try it out?
|
||||||
|
|
||||||
|
Check out the [documentation](https://continuwuity.org) for installation instructions.
|
||||||
|
|
||||||
|
There are currently no open registration continuwuity instances available.
|
||||||
|
|
||||||
|
## What are we working on?
|
||||||
|
|
||||||
|
We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
|
||||||
|
|
||||||
|
- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
|
||||||
|
- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
|
||||||
|
- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
|
||||||
|
- Automated testing
|
||||||
|
- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748)
|
||||||
|
- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750)
|
||||||
|
|
||||||
|
## Can I migrate my data from x?
|
||||||
|
|
||||||
|
- **Conduwuit**: Yes
|
||||||
|
- **Conduit**: No, database is now incompatible
|
||||||
|
- **Grapevine**: No, database is now incompatible
|
||||||
|
- **Dendrite**: No
|
||||||
|
- **Synapse**: No
|
||||||
|
|
||||||
|
We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this!
|
||||||
|
|
||||||
|
## How can I deploy my own?
|
||||||
|
|
||||||
|
- [Deployment options](deploying)
|
||||||
|
|
||||||
|
If you want to connect an appservice to continuwuity, take a look at the
|
||||||
|
[appservices documentation](appservices).
|
||||||
|
|
||||||
|
## How can I contribute?
|
||||||
|
|
||||||
|
See the [contributor's guide](development/contributing)
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and [space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) to chat with us about the project!
|
||||||
|
|
||||||
|
[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||||
|
|
@ -47,7 +47,7 @@ RocksDB troubleshooting can be found [in the RocksDB section of troubleshooting]
|
||||||
### Compression
|
### Compression
|
||||||
|
|
||||||
Some RocksDB settings can be adjusted such as the compression method chosen. See
|
Some RocksDB settings can be adjusted such as the compression method chosen. See
|
||||||
the RocksDB section in the [example config](configuration/examples.md).
|
the RocksDB section in the [example config](./reference/config.mdx).
|
||||||
|
|
||||||
btrfs users have reported that database compression does not need to be disabled
|
btrfs users have reported that database compression does not need to be disabled
|
||||||
on Continuwuity as the filesystem already does not attempt to compress. This can be
|
on Continuwuity as the filesystem already does not attempt to compress. This can be
|
||||||
|
|
@ -55,7 +55,7 @@ validated by using `filefrag -v` on a `.SST` file in your database, and ensure
|
||||||
the `physical_offset` matches (no filesystem compression). It is very important
|
the `physical_offset` matches (no filesystem compression). It is very important
|
||||||
to ensure no additional filesystem compression takes place as this can render
|
to ensure no additional filesystem compression takes place as this can render
|
||||||
unbuffered Direct IO inoperable, significantly slowing down read and write
|
unbuffered Direct IO inoperable, significantly slowing down read and write
|
||||||
performance. See <https://btrfs.readthedocs.io/en/latest/Compression.html#compatibility>
|
performance. See [the Btrfs docs](https://btrfs.readthedocs.io/en/latest/Compression.html#compatibility).
|
||||||
|
|
||||||
> Compression is done using the COW mechanism so it’s incompatible with
|
> Compression is done using the COW mechanism so it’s incompatible with
|
||||||
> nodatacow. Direct IO read works on compressed files but will fall back to
|
> nodatacow. Direct IO read works on compressed files but will fall back to
|
||||||
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
17
docs/reference/_meta.json
Normal file
17
docs/reference/_meta.json
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "config",
|
||||||
|
"label": "Configuration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "admin",
|
||||||
|
"label": "Admin Commands"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"name": "server",
|
||||||
|
"label": "Server command"
|
||||||
|
}
|
||||||
|
]
|
||||||
4
docs/reference/config.mdx
Normal file
4
docs/reference/config.mdx
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
|
||||||
|
```toml file="../../conduwuit-example.toml"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
{{#include ../SECURITY.md}}
|
|
||||||
1
docs/security.mdx
Symbolic link
1
docs/security.mdx
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../SECURITY.md
|
||||||
|
|
@ -128,7 +128,7 @@ if `PointInTime` does not work as a last ditch effort.
|
||||||
With this in mind:
|
With this in mind:
|
||||||
|
|
||||||
- First start Continuwuity with the `PointInTime` recovery method. See the [example
|
- First start Continuwuity with the `PointInTime` recovery method. See the [example
|
||||||
config](configuration/examples.md) for how to do this using
|
config](./reference/config.mdx) for how to do this using
|
||||||
`rocksdb_recovery_mode`
|
`rocksdb_recovery_mode`
|
||||||
- If your database successfully opens, clients are recommended to clear their
|
- If your database successfully opens, clients are recommended to clear their
|
||||||
client cache to account for the rollback
|
client cache to account for the rollback
|
||||||
|
|
@ -8,7 +8,7 @@ available as a Docker image.
|
||||||
|
|
||||||
Create a configuration file called `coturn.conf` containing:
|
Create a configuration file called `coturn.conf` containing:
|
||||||
|
|
||||||
```conf
|
```
|
||||||
use-auth-secret
|
use-auth-secret
|
||||||
static-auth-secret=<a secret key>
|
static-auth-secret=<a secret key>
|
||||||
realm=<your server domain>
|
realm=<your server domain>
|
||||||
|
|
@ -18,7 +18,7 @@ A common way to generate a suitable alphanumeric secret key is by using `pwgen
|
||||||
-s 64 1`.
|
-s 64 1`.
|
||||||
|
|
||||||
These same values need to be set in Continuwuity. See the [example
|
These same values need to be set in Continuwuity. See the [example
|
||||||
config](configuration/examples.md) in the TURN section for configuring these and
|
config](./reference/config.mdx) in the TURN section for configuring these and
|
||||||
restart Continuwuity after.
|
restart Continuwuity after.
|
||||||
|
|
||||||
`turn_secret` or a path to `turn_secret_file` must have a value of your
|
`turn_secret` or a path to `turn_secret_file` must have a value of your
|
||||||
5090
package-lock.json
generated
Normal file
5090
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
29
package.json
Normal file
29
package.json
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
{
|
||||||
|
"name": "continuwuation",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "<!-- ANCHOR: catchphrase -->",
|
||||||
|
"main": "index.js",
|
||||||
|
"directories": {
|
||||||
|
"doc": "docs",
|
||||||
|
"test": "tests"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"docs:dev": "rspress dev docs",
|
||||||
|
"docs:build": "rspress build docs",
|
||||||
|
"docs:preview": "rspress preview docs",
|
||||||
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "ssh://git@forgejo.ellis.link/continuwuation/continuwuity.git"
|
||||||
|
},
|
||||||
|
"keywords": [],
|
||||||
|
"author": "",
|
||||||
|
"license": "ISC",
|
||||||
|
"type": "commonjs",
|
||||||
|
"devDependencies": {
|
||||||
|
"@rspress/core": "^2.0.0-beta.35",
|
||||||
|
"@rspress/plugin-preview": "^2.0.0-beta.35",
|
||||||
|
"typescript": "^5.9.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -22,7 +22,7 @@ sudo apt install continuwuity
|
||||||
```
|
```
|
||||||
The `continuwuity` package conflicts with the old `conduwuit` package and will remove it automatically when installed.
|
The `continuwuity` package conflicts with the old `conduwuit` package and will remove it automatically when installed.
|
||||||
|
|
||||||
See the [generic deployment guide](../deploying/generic.md) for additional information about using the Debian package.
|
See the [generic deployment guide](/deploying/generic.mdx) for additional information about using the Debian package.
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
|
|
@ -32,8 +32,8 @@ You can customize additional settings by uncommenting and modifying the configur
|
||||||
|
|
||||||
### Running
|
### Running
|
||||||
|
|
||||||
The package uses the [`conduwuit.service`](../configuration/examples.md#example-systemd-unit-file) systemd unit file to start and stop Continuwuity. The binary installs at `/usr/bin/conduwuit`.
|
The package uses the `conduwuit.service` systemd unit file to start and stop Continuwuity. The binary installs at `/usr/bin/conduwuit`.
|
||||||
|
|
||||||
By default, this package assumes that Continuwuity runs behind a reverse proxy. The default configuration options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS. To federate properly, you must set up TLS certificates and certificate renewal.
|
By default, this package assumes that Continuwuity runs behind a reverse proxy. The default configuration options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS. To federate properly, you must set up TLS certificates and certificate renewal.
|
||||||
|
|
||||||
For information about setting up a reverse proxy and TLS, consult online documentation and guides. The [generic deployment guide](../deploying/generic.md#setting-up-the-reverse-proxy) documents Caddy, which is the most user-friendly option for reverse proxy configuration.
|
For information about setting up a reverse proxy and TLS, consult online documentation and guides. The [generic deployment guide](/deploying/generic.md#setting-up-the-reverse-proxy) documents Caddy, which is the most user-friendly option for reverse proxy configuration.
|
||||||
|
|
|
||||||
40
rspress.config.ts
Normal file
40
rspress.config.ts
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
import { defineConfig } from '@rspress/core';
|
||||||
|
import { pluginPreview } from '@rspress/plugin-preview';
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
root: 'docs',
|
||||||
|
title: 'continuwuity',
|
||||||
|
description: 'A community-driven Matrix homeserver in Rust',
|
||||||
|
icon: '/assets/logo.svg',
|
||||||
|
logo: {
|
||||||
|
light: '/assets/logo.svg',
|
||||||
|
dark: '/assets/logo.svg',
|
||||||
|
},
|
||||||
|
route: {
|
||||||
|
exclude: ['**/CONTRIBUTING.md', '**/README.md', '**/pkg/**', '**/target/**', '**/src/**', '**/tests/**'],
|
||||||
|
},
|
||||||
|
themeConfig: {
|
||||||
|
socialLinks: [
|
||||||
|
{
|
||||||
|
icon: 'github',
|
||||||
|
mode: 'link',
|
||||||
|
content: 'https://github.com/continuwuity/continuwuity',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
icon: {
|
||||||
|
svg: `<svg role="img" viewBox="0 0 24 24" width="100%" xmlns="http://www.w3.org/2000/svg"><title>Matrix</title><path fill="currentColor" d="M.632.55v22.9H2.28V24H0V0h2.28v.55zm7.043 7.26v1.157h.033c.309-.443.683-.784 1.117-1.024.433-.245.936-.365 1.5-.365.54 0 1.033.107 1.481.314.448.208.785.582 1.02 1.108.254-.374.6-.706 1.034-.992.434-.287.95-.43 1.546-.43.453 0 .872.056 1.26.167.388.11.716.286.993.53.276.245.489.559.646.951.152.392.23.863.23 1.417v5.728h-2.349V11.52c0-.286-.01-.559-.032-.812a1.755 1.755 0 0 0-.18-.66 1.106 1.106 0 0 0-.438-.448c-.194-.11-.457-.166-.785-.166-.332 0-.6.064-.803.189a1.38 1.38 0 0 0-.48.499 1.946 1.946 0 0 0-.231.696 5.56 5.56 0 0 0-.06.785v4.768h-2.35v-4.8c0-.254-.004-.503-.018-.752a2.074 2.074 0 0 0-.143-.688 1.052 1.052 0 0 0-.415-.503c-.194-.125-.476-.19-.854-.19-.111 0-.259.024-.439.074-.18.051-.36.143-.53.282-.171.138-.319.337-.439.595-.12.259-.18.6-.18 1.02v4.966H5.46V7.81zm15.693 15.64V.55H21.72V0H24v24h-2.28v-.55z"/></svg>`
|
||||||
|
},
|
||||||
|
mode: 'link',
|
||||||
|
content: 'https://matrix.to/#/#continuwuity:continuwuity.org',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
lastUpdated: true,
|
||||||
|
enableContentAnimation: true,
|
||||||
|
enableAppearanceAnimation: false,
|
||||||
|
footer: {
|
||||||
|
// message: 'Built with Rspress',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
plugins: [pluginPreview()],
|
||||||
|
});
|
||||||
|
|
@ -1,612 +0,0 @@
|
||||||
/* CSS for UI elements (a.k.a. chrome) */
|
|
||||||
|
|
||||||
@import 'variables.css';
|
|
||||||
|
|
||||||
html {
|
|
||||||
scrollbar-color: var(--scrollbar) var(--bg);
|
|
||||||
}
|
|
||||||
#searchresults a,
|
|
||||||
.content a:link,
|
|
||||||
a:visited,
|
|
||||||
a > .hljs {
|
|
||||||
color: var(--links);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
body-container is necessary because mobile browsers don't seem to like
|
|
||||||
overflow-x on the body tag when there is a <meta name="viewport"> tag.
|
|
||||||
*/
|
|
||||||
#body-container {
|
|
||||||
/*
|
|
||||||
This is used when the sidebar pushes the body content off the side of
|
|
||||||
the screen on small screens. Without it, dragging on mobile Safari
|
|
||||||
will want to reposition the viewport in a weird way.
|
|
||||||
*/
|
|
||||||
overflow-x: clip;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Menu Bar */
|
|
||||||
|
|
||||||
#menu-bar,
|
|
||||||
#menu-bar-hover-placeholder {
|
|
||||||
z-index: 101;
|
|
||||||
margin: auto calc(0px - var(--page-padding));
|
|
||||||
}
|
|
||||||
#menu-bar {
|
|
||||||
position: relative;
|
|
||||||
display: flex;
|
|
||||||
flex-wrap: wrap;
|
|
||||||
background-color: var(--bg);
|
|
||||||
border-block-end-color: var(--bg);
|
|
||||||
border-block-end-width: 1px;
|
|
||||||
border-block-end-style: solid;
|
|
||||||
}
|
|
||||||
#menu-bar.sticky,
|
|
||||||
.js #menu-bar-hover-placeholder:hover + #menu-bar,
|
|
||||||
.js #menu-bar:hover,
|
|
||||||
.js.sidebar-visible #menu-bar {
|
|
||||||
position: -webkit-sticky;
|
|
||||||
position: sticky;
|
|
||||||
top: 0 !important;
|
|
||||||
}
|
|
||||||
#menu-bar-hover-placeholder {
|
|
||||||
position: sticky;
|
|
||||||
position: -webkit-sticky;
|
|
||||||
top: 0;
|
|
||||||
height: var(--menu-bar-height);
|
|
||||||
}
|
|
||||||
#menu-bar.bordered {
|
|
||||||
border-block-end-color: var(--table-border-color);
|
|
||||||
}
|
|
||||||
#menu-bar i, #menu-bar .icon-button {
|
|
||||||
position: relative;
|
|
||||||
padding: 0 8px;
|
|
||||||
z-index: 10;
|
|
||||||
line-height: var(--menu-bar-height);
|
|
||||||
cursor: pointer;
|
|
||||||
transition: color 0.5s;
|
|
||||||
}
|
|
||||||
@media only screen and (max-width: 420px) {
|
|
||||||
#menu-bar i, #menu-bar .icon-button {
|
|
||||||
padding: 0 5px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.icon-button {
|
|
||||||
border: none;
|
|
||||||
background: none;
|
|
||||||
padding: 0;
|
|
||||||
color: inherit;
|
|
||||||
}
|
|
||||||
.icon-button i {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.right-buttons {
|
|
||||||
margin: 0 15px;
|
|
||||||
}
|
|
||||||
.right-buttons a {
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.left-buttons {
|
|
||||||
display: flex;
|
|
||||||
margin: 0 5px;
|
|
||||||
}
|
|
||||||
.no-js .left-buttons button {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.menu-title {
|
|
||||||
display: inline-block;
|
|
||||||
font-weight: 400;
|
|
||||||
font-size: 2.4rem;
|
|
||||||
line-height: var(--menu-bar-height);
|
|
||||||
text-align: center;
|
|
||||||
margin: 0;
|
|
||||||
flex: 1;
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
color: #bb7fb2;
|
|
||||||
}
|
|
||||||
.js .menu-title {
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
.menu-bar,
|
|
||||||
.menu-bar:visited,
|
|
||||||
.nav-chapters,
|
|
||||||
.nav-chapters:visited,
|
|
||||||
.mobile-nav-chapters,
|
|
||||||
.mobile-nav-chapters:visited,
|
|
||||||
.menu-bar .icon-button,
|
|
||||||
.menu-bar a i {
|
|
||||||
color: var(--icons);
|
|
||||||
}
|
|
||||||
|
|
||||||
.menu-bar i:hover,
|
|
||||||
.menu-bar .icon-button:hover,
|
|
||||||
.nav-chapters:hover,
|
|
||||||
.mobile-nav-chapters i:hover {
|
|
||||||
color: var(--icons-hover);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Nav Icons */
|
|
||||||
|
|
||||||
.nav-chapters {
|
|
||||||
font-size: 2.5em;
|
|
||||||
text-align: center;
|
|
||||||
text-decoration: none;
|
|
||||||
|
|
||||||
position: fixed;
|
|
||||||
top: 0;
|
|
||||||
bottom: 0;
|
|
||||||
margin: 0;
|
|
||||||
max-width: 150px;
|
|
||||||
min-width: 90px;
|
|
||||||
|
|
||||||
display: flex;
|
|
||||||
justify-content: center;
|
|
||||||
align-content: center;
|
|
||||||
flex-direction: column;
|
|
||||||
|
|
||||||
transition: color 0.5s, background-color 0.5s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.nav-chapters:hover {
|
|
||||||
text-decoration: none;
|
|
||||||
background-color: var(--theme-hover);
|
|
||||||
transition: background-color 0.15s, color 0.15s;
|
|
||||||
}
|
|
||||||
|
|
||||||
.nav-wrapper {
|
|
||||||
margin-block-start: 50px;
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.mobile-nav-chapters {
|
|
||||||
font-size: 2.5em;
|
|
||||||
text-align: center;
|
|
||||||
text-decoration: none;
|
|
||||||
width: 90px;
|
|
||||||
border-radius: 5px;
|
|
||||||
background-color: var(--sidebar-bg);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Only Firefox supports flow-relative values */
|
|
||||||
.previous { float: left; }
|
|
||||||
[dir=rtl] .previous { float: right; }
|
|
||||||
|
|
||||||
/* Only Firefox supports flow-relative values */
|
|
||||||
.next {
|
|
||||||
float: right;
|
|
||||||
right: var(--page-padding);
|
|
||||||
}
|
|
||||||
[dir=rtl] .next {
|
|
||||||
float: left;
|
|
||||||
right: unset;
|
|
||||||
left: var(--page-padding);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Use the correct buttons for RTL layouts*/
|
|
||||||
[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
|
|
||||||
[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
|
|
||||||
|
|
||||||
@media only screen and (max-width: 1080px) {
|
|
||||||
.nav-wide-wrapper { display: none; }
|
|
||||||
.nav-wrapper { display: block; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/* sidebar-visible */
|
|
||||||
@media only screen and (max-width: 1380px) {
|
|
||||||
#sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
|
|
||||||
#sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Inline code */
|
|
||||||
|
|
||||||
:not(pre) > .hljs {
|
|
||||||
display: inline;
|
|
||||||
padding: 0.1em 0.3em;
|
|
||||||
border-radius: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
:not(pre):not(a) > .hljs {
|
|
||||||
color: var(--inline-code-color);
|
|
||||||
overflow-x: initial;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover > .hljs {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre {
|
|
||||||
position: relative;
|
|
||||||
}
|
|
||||||
pre > .buttons {
|
|
||||||
position: absolute;
|
|
||||||
z-index: 100;
|
|
||||||
right: 0px;
|
|
||||||
top: 2px;
|
|
||||||
margin: 0px;
|
|
||||||
padding: 2px 0px;
|
|
||||||
|
|
||||||
color: var(--sidebar-fg);
|
|
||||||
cursor: pointer;
|
|
||||||
visibility: hidden;
|
|
||||||
opacity: 0;
|
|
||||||
transition: visibility 0.1s linear, opacity 0.1s linear;
|
|
||||||
}
|
|
||||||
pre:hover > .buttons {
|
|
||||||
visibility: visible;
|
|
||||||
opacity: 1
|
|
||||||
}
|
|
||||||
pre > .buttons :hover {
|
|
||||||
color: var(--sidebar-active);
|
|
||||||
border-color: var(--icons-hover);
|
|
||||||
background-color: var(--theme-hover);
|
|
||||||
}
|
|
||||||
pre > .buttons i {
|
|
||||||
margin-inline-start: 8px;
|
|
||||||
}
|
|
||||||
pre > .buttons button {
|
|
||||||
cursor: inherit;
|
|
||||||
margin: 0px 5px;
|
|
||||||
padding: 3px 5px;
|
|
||||||
font-size: 14px;
|
|
||||||
|
|
||||||
border-style: solid;
|
|
||||||
border-width: 1px;
|
|
||||||
border-radius: 4px;
|
|
||||||
border-color: var(--icons);
|
|
||||||
background-color: var(--theme-popup-bg);
|
|
||||||
transition: 100ms;
|
|
||||||
transition-property: color,border-color,background-color;
|
|
||||||
color: var(--icons);
|
|
||||||
}
|
|
||||||
@media (pointer: coarse) {
|
|
||||||
pre > .buttons button {
|
|
||||||
/* On mobile, make it easier to tap buttons. */
|
|
||||||
padding: 0.3rem 1rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sidebar-resize-indicator {
|
|
||||||
/* Hide resize indicator on devices with limited accuracy */
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pre > code {
|
|
||||||
display: block;
|
|
||||||
padding: 1rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* FIXME: ACE editors overlap their buttons because ACE does absolute
|
|
||||||
positioning within the code block which breaks padding. The only solution I
|
|
||||||
can think of is to move the padding to the outer pre tag (or insert a div
|
|
||||||
wrapper), but that would require fixing a whole bunch of CSS rules.
|
|
||||||
*/
|
|
||||||
.hljs.ace_editor {
|
|
||||||
padding: 0rem 0rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre > .result {
|
|
||||||
margin-block-start: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Search */
|
|
||||||
|
|
||||||
#searchresults a {
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
mark {
|
|
||||||
border-radius: 2px;
|
|
||||||
padding-block-start: 0;
|
|
||||||
padding-block-end: 1px;
|
|
||||||
padding-inline-start: 3px;
|
|
||||||
padding-inline-end: 3px;
|
|
||||||
margin-block-start: 0;
|
|
||||||
margin-block-end: -1px;
|
|
||||||
margin-inline-start: -3px;
|
|
||||||
margin-inline-end: -3px;
|
|
||||||
background-color: var(--search-mark-bg);
|
|
||||||
transition: background-color 300ms linear;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
mark.fade-out {
|
|
||||||
background-color: rgba(0,0,0,0) !important;
|
|
||||||
cursor: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.searchbar-outer {
|
|
||||||
margin-inline-start: auto;
|
|
||||||
margin-inline-end: auto;
|
|
||||||
max-width: var(--content-max-width);
|
|
||||||
}
|
|
||||||
|
|
||||||
#searchbar {
|
|
||||||
width: 100%;
|
|
||||||
margin-block-start: 5px;
|
|
||||||
margin-block-end: 0;
|
|
||||||
margin-inline-start: auto;
|
|
||||||
margin-inline-end: auto;
|
|
||||||
padding: 10px 16px;
|
|
||||||
transition: box-shadow 300ms ease-in-out;
|
|
||||||
border: 1px solid var(--searchbar-border-color);
|
|
||||||
border-radius: 3px;
|
|
||||||
background-color: var(--searchbar-bg);
|
|
||||||
color: var(--searchbar-fg);
|
|
||||||
}
|
|
||||||
#searchbar:focus,
|
|
||||||
#searchbar.active {
|
|
||||||
box-shadow: 0 0 3px var(--searchbar-shadow-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
.searchresults-header {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 1em;
|
|
||||||
padding-block-start: 18px;
|
|
||||||
padding-block-end: 0;
|
|
||||||
padding-inline-start: 5px;
|
|
||||||
padding-inline-end: 0;
|
|
||||||
color: var(--searchresults-header-fg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.searchresults-outer {
|
|
||||||
margin-inline-start: auto;
|
|
||||||
margin-inline-end: auto;
|
|
||||||
max-width: var(--content-max-width);
|
|
||||||
border-block-end: 1px dashed var(--searchresults-border-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
ul#searchresults {
|
|
||||||
list-style: none;
|
|
||||||
padding-inline-start: 20px;
|
|
||||||
}
|
|
||||||
ul#searchresults li {
|
|
||||||
margin: 10px 0px;
|
|
||||||
padding: 2px;
|
|
||||||
border-radius: 2px;
|
|
||||||
}
|
|
||||||
ul#searchresults li.focus {
|
|
||||||
background-color: var(--searchresults-li-bg);
|
|
||||||
}
|
|
||||||
ul#searchresults span.teaser {
|
|
||||||
display: block;
|
|
||||||
clear: both;
|
|
||||||
margin-block-start: 5px;
|
|
||||||
margin-block-end: 0;
|
|
||||||
margin-inline-start: 20px;
|
|
||||||
margin-inline-end: 0;
|
|
||||||
font-size: 0.8em;
|
|
||||||
}
|
|
||||||
ul#searchresults span.teaser em {
|
|
||||||
font-weight: bold;
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Sidebar */
|
|
||||||
|
|
||||||
.sidebar {
|
|
||||||
position: fixed;
|
|
||||||
left: 0;
|
|
||||||
top: 0;
|
|
||||||
bottom: 0;
|
|
||||||
width: var(--sidebar-width);
|
|
||||||
font-size: 0.875em;
|
|
||||||
box-sizing: border-box;
|
|
||||||
-webkit-overflow-scrolling: touch;
|
|
||||||
overscroll-behavior-y: contain;
|
|
||||||
background-color: var(--sidebar-bg);
|
|
||||||
color: var(--sidebar-fg);
|
|
||||||
}
|
|
||||||
[dir=rtl] .sidebar { left: unset; right: 0; }
|
|
||||||
.sidebar-resizing {
|
|
||||||
-moz-user-select: none;
|
|
||||||
-webkit-user-select: none;
|
|
||||||
-ms-user-select: none;
|
|
||||||
user-select: none;
|
|
||||||
}
|
|
||||||
.no-js .sidebar,
|
|
||||||
.js:not(.sidebar-resizing) .sidebar {
|
|
||||||
transition: transform 0.3s; /* Animation: slide away */
|
|
||||||
}
|
|
||||||
.sidebar code {
|
|
||||||
line-height: 2em;
|
|
||||||
}
|
|
||||||
.sidebar .sidebar-scrollbox {
|
|
||||||
overflow-y: auto;
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
bottom: 0;
|
|
||||||
left: 0;
|
|
||||||
right: 0;
|
|
||||||
padding: 10px 10px;
|
|
||||||
}
|
|
||||||
.sidebar .sidebar-resize-handle {
|
|
||||||
position: absolute;
|
|
||||||
cursor: col-resize;
|
|
||||||
width: 0;
|
|
||||||
right: calc(var(--sidebar-resize-indicator-width) * -1);
|
|
||||||
top: 0;
|
|
||||||
bottom: 0;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sidebar-resize-handle .sidebar-resize-indicator {
|
|
||||||
width: 100%;
|
|
||||||
height: 12px;
|
|
||||||
background-color: var(--icons);
|
|
||||||
margin-inline-start: var(--sidebar-resize-indicator-space);
|
|
||||||
}
|
|
||||||
|
|
||||||
[dir=rtl] .sidebar .sidebar-resize-handle {
|
|
||||||
left: calc(var(--sidebar-resize-indicator-width) * -1);
|
|
||||||
right: unset;
|
|
||||||
}
|
|
||||||
.js .sidebar .sidebar-resize-handle {
|
|
||||||
cursor: col-resize;
|
|
||||||
width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
|
|
||||||
}
|
|
||||||
/* sidebar-hidden */
|
|
||||||
#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
|
|
||||||
transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
|
|
||||||
z-index: -1;
|
|
||||||
}
|
|
||||||
[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
|
|
||||||
transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
|
|
||||||
}
|
|
||||||
.sidebar::-webkit-scrollbar {
|
|
||||||
background: var(--sidebar-bg);
|
|
||||||
}
|
|
||||||
.sidebar::-webkit-scrollbar-thumb {
|
|
||||||
background: var(--scrollbar);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* sidebar-visible */
|
|
||||||
#sidebar-toggle-anchor:checked ~ .page-wrapper {
|
|
||||||
transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
|
|
||||||
}
|
|
||||||
[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
|
|
||||||
transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
|
|
||||||
}
|
|
||||||
@media only screen and (min-width: 620px) {
|
|
||||||
#sidebar-toggle-anchor:checked ~ .page-wrapper {
|
|
||||||
transform: none;
|
|
||||||
margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
|
|
||||||
}
|
|
||||||
[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
|
|
||||||
transform: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter {
|
|
||||||
list-style: none outside none;
|
|
||||||
padding-inline-start: 0;
|
|
||||||
line-height: 2.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter ol {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li {
|
|
||||||
display: flex;
|
|
||||||
color: var(--sidebar-non-existent);
|
|
||||||
}
|
|
||||||
.chapter li a {
|
|
||||||
display: block;
|
|
||||||
padding: 0;
|
|
||||||
text-decoration: none;
|
|
||||||
color: var(--sidebar-fg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li a:hover {
|
|
||||||
color: var(--sidebar-active);
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li a.active {
|
|
||||||
color: var(--sidebar-active);
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li > a.toggle {
|
|
||||||
cursor: pointer;
|
|
||||||
display: block;
|
|
||||||
margin-inline-start: auto;
|
|
||||||
padding: 0 10px;
|
|
||||||
user-select: none;
|
|
||||||
opacity: 0.68;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li > a.toggle div {
|
|
||||||
transition: transform 0.5s;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* collapse the section */
|
|
||||||
.chapter li:not(.expanded) + li > ol {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li.chapter-item {
|
|
||||||
line-height: 1.5em;
|
|
||||||
margin-block-start: 0.6em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li.expanded > a.toggle div {
|
|
||||||
transform: rotate(90deg);
|
|
||||||
}
|
|
||||||
|
|
||||||
.spacer {
|
|
||||||
width: 100%;
|
|
||||||
height: 3px;
|
|
||||||
margin: 5px 0px;
|
|
||||||
}
|
|
||||||
.chapter .spacer {
|
|
||||||
background-color: var(--sidebar-spacer);
|
|
||||||
}
|
|
||||||
|
|
||||||
@media (-moz-touch-enabled: 1), (pointer: coarse) {
|
|
||||||
.chapter li a { padding: 5px 0; }
|
|
||||||
.spacer { margin: 10px 0; }
|
|
||||||
}
|
|
||||||
|
|
||||||
.section {
|
|
||||||
list-style: none outside none;
|
|
||||||
padding-inline-start: 20px;
|
|
||||||
line-height: 1.9em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Theme Menu Popup */
|
|
||||||
|
|
||||||
.theme-popup {
|
|
||||||
position: absolute;
|
|
||||||
left: 10px;
|
|
||||||
top: var(--menu-bar-height);
|
|
||||||
z-index: 1000;
|
|
||||||
border-radius: 4px;
|
|
||||||
font-size: 0.7em;
|
|
||||||
color: var(--fg);
|
|
||||||
background: var(--theme-popup-bg);
|
|
||||||
border: 1px solid var(--theme-popup-border);
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
list-style: none;
|
|
||||||
display: none;
|
|
||||||
/* Don't let the children's background extend past the rounded corners. */
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
[dir=rtl] .theme-popup { left: unset; right: 10px; }
|
|
||||||
.theme-popup .default {
|
|
||||||
color: var(--icons);
|
|
||||||
}
|
|
||||||
.theme-popup .theme {
|
|
||||||
width: 100%;
|
|
||||||
border: 0;
|
|
||||||
margin: 0;
|
|
||||||
padding: 2px 20px;
|
|
||||||
line-height: 25px;
|
|
||||||
white-space: nowrap;
|
|
||||||
text-align: start;
|
|
||||||
cursor: pointer;
|
|
||||||
color: inherit;
|
|
||||||
background: inherit;
|
|
||||||
font-size: inherit;
|
|
||||||
}
|
|
||||||
.theme-popup .theme:hover {
|
|
||||||
background-color: var(--theme-hover);
|
|
||||||
}
|
|
||||||
|
|
||||||
.theme-selected::before {
|
|
||||||
display: inline-block;
|
|
||||||
content: "✓";
|
|
||||||
margin-inline-start: -14px;
|
|
||||||
width: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* HACK: Stop the keyboard shortcuts from adding a giant space at the top */
|
|
||||||
#mdbook-help-container {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
@ -1,234 +0,0 @@
|
||||||
/* Base styles and content styles */
|
|
||||||
|
|
||||||
@import 'variables.css';
|
|
||||||
|
|
||||||
:root {
|
|
||||||
/* Browser default font-size is 16px, this way 1 rem = 10px */
|
|
||||||
font-size: 62.5%;
|
|
||||||
color-scheme: var(--color-scheme);
|
|
||||||
}
|
|
||||||
|
|
||||||
html {
|
|
||||||
font-family: "Open Sans", sans-serif;
|
|
||||||
color: var(--fg);
|
|
||||||
background-color: var(--bg);
|
|
||||||
text-size-adjust: none;
|
|
||||||
-webkit-text-size-adjust: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
margin: 0;
|
|
||||||
font-size: 1.6rem;
|
|
||||||
overflow-x: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
code {
|
|
||||||
font-family: var(--mono-font) !important;
|
|
||||||
font-size: var(--code-font-size);
|
|
||||||
direction: ltr !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* make long words/inline code not x overflow */
|
|
||||||
main {
|
|
||||||
overflow-wrap: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* make wide tables scroll if they overflow */
|
|
||||||
.table-wrapper {
|
|
||||||
overflow-x: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Don't change font size in headers. */
|
|
||||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
|
||||||
font-size: unset;
|
|
||||||
}
|
|
||||||
|
|
||||||
.left { float: left; }
|
|
||||||
.right { float: right; }
|
|
||||||
.boring { opacity: 0.6; }
|
|
||||||
.hide-boring .boring { display: none; }
|
|
||||||
.hidden { display: none !important; }
|
|
||||||
|
|
||||||
h2, h3 { margin-block-start: 2.5em; }
|
|
||||||
h4, h5 { margin-block-start: 2em; }
|
|
||||||
|
|
||||||
.header + .header h3,
|
|
||||||
.header + .header h4,
|
|
||||||
.header + .header h5 {
|
|
||||||
margin-block-start: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1:target::before,
|
|
||||||
h2:target::before,
|
|
||||||
h3:target::before,
|
|
||||||
h4:target::before,
|
|
||||||
h5:target::before,
|
|
||||||
h6:target::before {
|
|
||||||
display: inline-block;
|
|
||||||
content: "»";
|
|
||||||
margin-inline-start: -30px;
|
|
||||||
width: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* This is broken on Safari as of version 14, but is fixed
|
|
||||||
in Safari Technology Preview 117 which I think will be Safari 14.2.
|
|
||||||
https://bugs.webkit.org/show_bug.cgi?id=218076
|
|
||||||
*/
|
|
||||||
:target {
|
|
||||||
/* Safari does not support logical properties */
|
|
||||||
scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
|
|
||||||
}
|
|
||||||
|
|
||||||
.page {
|
|
||||||
outline: 0;
|
|
||||||
padding: 0 var(--page-padding);
|
|
||||||
margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
|
|
||||||
}
|
|
||||||
.page-wrapper {
|
|
||||||
box-sizing: border-box;
|
|
||||||
background-color: var(--bg);
|
|
||||||
}
|
|
||||||
.no-js .page-wrapper,
|
|
||||||
.js:not(.sidebar-resizing) .page-wrapper {
|
|
||||||
transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
|
|
||||||
}
|
|
||||||
[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
|
|
||||||
transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
|
|
||||||
}
|
|
||||||
|
|
||||||
.content {
|
|
||||||
overflow-y: auto;
|
|
||||||
padding: 0 5px 50px 5px;
|
|
||||||
}
|
|
||||||
.content main {
|
|
||||||
margin-inline-start: auto;
|
|
||||||
margin-inline-end: auto;
|
|
||||||
max-width: var(--content-max-width);
|
|
||||||
}
|
|
||||||
.content p { line-height: 1.45em; }
|
|
||||||
.content ol { line-height: 1.45em; }
|
|
||||||
.content ul { line-height: 1.45em; }
|
|
||||||
.content a { text-decoration: none; }
|
|
||||||
.content a:hover { text-decoration: underline; }
|
|
||||||
.content img, .content video { max-width: 100%; }
|
|
||||||
.content .header:link,
|
|
||||||
.content .header:visited {
|
|
||||||
color: var(--fg);
|
|
||||||
}
|
|
||||||
.content .header:link,
|
|
||||||
.content .header:visited:hover {
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
table {
|
|
||||||
margin: 0 auto;
|
|
||||||
border-collapse: collapse;
|
|
||||||
}
|
|
||||||
table td {
|
|
||||||
padding: 3px 20px;
|
|
||||||
border: 1px var(--table-border-color) solid;
|
|
||||||
}
|
|
||||||
table thead {
|
|
||||||
background: var(--table-header-bg);
|
|
||||||
}
|
|
||||||
table thead td {
|
|
||||||
font-weight: 700;
|
|
||||||
border: none;
|
|
||||||
}
|
|
||||||
table thead th {
|
|
||||||
padding: 3px 20px;
|
|
||||||
}
|
|
||||||
table thead tr {
|
|
||||||
border: 1px var(--table-header-bg) solid;
|
|
||||||
}
|
|
||||||
/* Alternate background colors for rows */
|
|
||||||
table tbody tr:nth-child(2n) {
|
|
||||||
background: var(--table-alternate-bg);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
blockquote {
|
|
||||||
margin: 20px 0;
|
|
||||||
padding: 0 20px;
|
|
||||||
color: var(--fg);
|
|
||||||
background-color: var(--quote-bg);
|
|
||||||
border-block-start: .1em solid var(--quote-border);
|
|
||||||
border-block-end: .1em solid var(--quote-border);
|
|
||||||
}
|
|
||||||
|
|
||||||
.warning {
|
|
||||||
margin: 20px;
|
|
||||||
padding: 0 20px;
|
|
||||||
border-inline-start: 2px solid var(--warning-border);
|
|
||||||
}
|
|
||||||
|
|
||||||
.warning:before {
|
|
||||||
position: absolute;
|
|
||||||
width: 3rem;
|
|
||||||
height: 3rem;
|
|
||||||
margin-inline-start: calc(-1.5rem - 21px);
|
|
||||||
content: "ⓘ";
|
|
||||||
text-align: center;
|
|
||||||
background-color: var(--bg);
|
|
||||||
color: var(--warning-border);
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 2rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
blockquote .warning:before {
|
|
||||||
background-color: var(--quote-bg);
|
|
||||||
}
|
|
||||||
|
|
||||||
kbd {
|
|
||||||
background-color: var(--table-border-color);
|
|
||||||
border-radius: 4px;
|
|
||||||
border: solid 1px var(--theme-popup-border);
|
|
||||||
box-shadow: inset 0 -1px 0 var(--theme-hover);
|
|
||||||
display: inline-block;
|
|
||||||
font-size: var(--code-font-size);
|
|
||||||
font-family: var(--mono-font);
|
|
||||||
line-height: 10px;
|
|
||||||
padding: 4px 5px;
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
:not(.footnote-definition) + .footnote-definition,
|
|
||||||
.footnote-definition + :not(.footnote-definition) {
|
|
||||||
margin-block-start: 2em;
|
|
||||||
}
|
|
||||||
.footnote-definition {
|
|
||||||
font-size: 0.9em;
|
|
||||||
margin: 0.5em 0;
|
|
||||||
}
|
|
||||||
.footnote-definition p {
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tooltiptext {
|
|
||||||
position: absolute;
|
|
||||||
visibility: hidden;
|
|
||||||
color: #fff;
|
|
||||||
background-color: #333;
|
|
||||||
transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
|
|
||||||
left: -8px; /* Half of the width of the icon */
|
|
||||||
top: -35px;
|
|
||||||
font-size: 0.8em;
|
|
||||||
text-align: center;
|
|
||||||
border-radius: 6px;
|
|
||||||
padding: 5px 8px;
|
|
||||||
margin: 5px;
|
|
||||||
z-index: 1000;
|
|
||||||
}
|
|
||||||
.tooltipped .tooltiptext {
|
|
||||||
visibility: visible;
|
|
||||||
}
|
|
||||||
|
|
||||||
.chapter li.part-title {
|
|
||||||
color: var(--sidebar-fg);
|
|
||||||
margin: 5px 0px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.result-no-output {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
@ -1,279 +0,0 @@
|
||||||
/* Globals */
|
|
||||||
|
|
||||||
:root {
|
|
||||||
--sidebar-width: 300px;
|
|
||||||
--sidebar-resize-indicator-width: 8px;
|
|
||||||
--sidebar-resize-indicator-space: 2px;
|
|
||||||
--page-padding: 15px;
|
|
||||||
--content-max-width: 750px;
|
|
||||||
--menu-bar-height: 50px;
|
|
||||||
--mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
|
|
||||||
--code-font-size: 0.875em
|
|
||||||
/* please adjust the ace font size accordingly in editor.js */
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Themes */
|
|
||||||
|
|
||||||
.ayu {
|
|
||||||
--bg: hsl(210, 25%, 8%);
|
|
||||||
--fg: #c5c5c5;
|
|
||||||
|
|
||||||
--sidebar-bg: #14191f;
|
|
||||||
--sidebar-fg: #c8c9db;
|
|
||||||
--sidebar-non-existent: #5c6773;
|
|
||||||
--sidebar-active: #ffb454;
|
|
||||||
--sidebar-spacer: #2d334f;
|
|
||||||
|
|
||||||
--scrollbar: var(--sidebar-fg);
|
|
||||||
|
|
||||||
--icons: #737480;
|
|
||||||
--icons-hover: #b7b9cc;
|
|
||||||
|
|
||||||
--links: #0096cf;
|
|
||||||
|
|
||||||
--inline-code-color: #ffb454;
|
|
||||||
|
|
||||||
--theme-popup-bg: #14191f;
|
|
||||||
--theme-popup-border: #5c6773;
|
|
||||||
--theme-hover: #191f26;
|
|
||||||
|
|
||||||
--quote-bg: hsl(226, 15%, 17%);
|
|
||||||
--quote-border: hsl(226, 15%, 22%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(210, 25%, 13%);
|
|
||||||
--table-header-bg: hsl(210, 25%, 28%);
|
|
||||||
--table-alternate-bg: hsl(210, 25%, 11%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #848484;
|
|
||||||
--searchbar-bg: #424242;
|
|
||||||
--searchbar-fg: #fff;
|
|
||||||
--searchbar-shadow-color: #d4c89f;
|
|
||||||
--searchresults-header-fg: #666;
|
|
||||||
--searchresults-border-color: #888;
|
|
||||||
--searchresults-li-bg: #252932;
|
|
||||||
--search-mark-bg: #e3b171;
|
|
||||||
|
|
||||||
--color-scheme: dark;
|
|
||||||
}
|
|
||||||
|
|
||||||
.coal {
|
|
||||||
--bg: hsl(200, 7%, 8%);
|
|
||||||
--fg: #98a3ad;
|
|
||||||
|
|
||||||
--sidebar-bg: #292c2f;
|
|
||||||
--sidebar-fg: #a1adb8;
|
|
||||||
--sidebar-non-existent: #505254;
|
|
||||||
--sidebar-active: #3473ad;
|
|
||||||
--sidebar-spacer: #393939;
|
|
||||||
|
|
||||||
--scrollbar: var(--sidebar-fg);
|
|
||||||
|
|
||||||
--icons: #43484d;
|
|
||||||
--icons-hover: #b3c0cc;
|
|
||||||
|
|
||||||
--links: #2b79a2;
|
|
||||||
|
|
||||||
--inline-code-color: #c5c8c6;
|
|
||||||
|
|
||||||
--theme-popup-bg: #141617;
|
|
||||||
--theme-popup-border: #43484d;
|
|
||||||
--theme-hover: #1f2124;
|
|
||||||
|
|
||||||
--quote-bg: hsl(234, 21%, 18%);
|
|
||||||
--quote-border: hsl(234, 21%, 23%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(200, 7%, 13%);
|
|
||||||
--table-header-bg: hsl(200, 7%, 28%);
|
|
||||||
--table-alternate-bg: hsl(200, 7%, 11%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #aaa;
|
|
||||||
--searchbar-bg: #b7b7b7;
|
|
||||||
--searchbar-fg: #000;
|
|
||||||
--searchbar-shadow-color: #aaa;
|
|
||||||
--searchresults-header-fg: #666;
|
|
||||||
--searchresults-border-color: #98a3ad;
|
|
||||||
--searchresults-li-bg: #2b2b2f;
|
|
||||||
--search-mark-bg: #355c7d;
|
|
||||||
|
|
||||||
--color-scheme: dark;
|
|
||||||
}
|
|
||||||
|
|
||||||
.light {
|
|
||||||
--bg: hsl(0, 0%, 100%);
|
|
||||||
--fg: hsl(0, 0%, 0%);
|
|
||||||
|
|
||||||
--sidebar-bg: #fafafa;
|
|
||||||
--sidebar-fg: #AE518E;
|
|
||||||
--sidebar-non-existent: #aaaaaa;
|
|
||||||
--sidebar-active: #2F7E86;
|
|
||||||
--sidebar-spacer: #f4f4f4;
|
|
||||||
|
|
||||||
--scrollbar: #8F8F8F;
|
|
||||||
|
|
||||||
--icons: #747474;
|
|
||||||
--icons-hover: #000000;
|
|
||||||
|
|
||||||
--links: #429EC2;
|
|
||||||
|
|
||||||
--inline-code-color: #9d579d;
|
|
||||||
|
|
||||||
--theme-popup-bg: #fafafa;
|
|
||||||
--theme-popup-border: #cccccc;
|
|
||||||
--theme-hover: #e6e6e6;
|
|
||||||
|
|
||||||
--quote-bg: hsl(197, 37%, 96%);
|
|
||||||
--quote-border: hsl(197, 37%, 91%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(0, 0%, 95%);
|
|
||||||
--table-header-bg: hsl(0, 0%, 80%);
|
|
||||||
--table-alternate-bg: hsl(0, 0%, 97%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #aaa;
|
|
||||||
--searchbar-bg: #fafafa;
|
|
||||||
--searchbar-fg: #000;
|
|
||||||
--searchbar-shadow-color: #aaa;
|
|
||||||
--searchresults-header-fg: #666;
|
|
||||||
--searchresults-border-color: #888;
|
|
||||||
--searchresults-li-bg: #e4f2fe;
|
|
||||||
--search-mark-bg: #a2cff5;
|
|
||||||
|
|
||||||
--color-scheme: light;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navy {
|
|
||||||
--bg: hsl(226, 23%, 11%);
|
|
||||||
--fg: #dfd3db;
|
|
||||||
|
|
||||||
--sidebar-bg: #282d3f;
|
|
||||||
--sidebar-fg: #fdcbec;
|
|
||||||
--sidebar-non-existent: #505274;
|
|
||||||
--sidebar-active: #5BCEFA;
|
|
||||||
--sidebar-spacer: #2d334f;
|
|
||||||
|
|
||||||
--scrollbar: var(--sidebar-fg);
|
|
||||||
|
|
||||||
--icons: #fdcbec;
|
|
||||||
--icons-hover: #5BCEFA;
|
|
||||||
|
|
||||||
--links: #5BCEFA;
|
|
||||||
|
|
||||||
--inline-code-color: #bd66bc;
|
|
||||||
|
|
||||||
--theme-popup-bg: #161923;
|
|
||||||
--theme-popup-border: #737480;
|
|
||||||
--theme-hover: #282e40;
|
|
||||||
|
|
||||||
--quote-bg: hsl(226, 15%, 17%);
|
|
||||||
--quote-border: hsl(226, 15%, 22%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(226, 23%, 16%);
|
|
||||||
--table-header-bg: hsl(226, 23%, 31%);
|
|
||||||
--table-alternate-bg: hsl(226, 23%, 14%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #aaa;
|
|
||||||
--searchbar-bg: #aeaec6;
|
|
||||||
--searchbar-fg: #000;
|
|
||||||
--searchbar-shadow-color: #aaa;
|
|
||||||
--searchresults-header-fg: #5f5f71;
|
|
||||||
--searchresults-border-color: #5c5c68;
|
|
||||||
--searchresults-li-bg: #242430;
|
|
||||||
--search-mark-bg: #a2cff5;
|
|
||||||
|
|
||||||
--color-scheme: dark;
|
|
||||||
}
|
|
||||||
|
|
||||||
.rust {
|
|
||||||
--bg: hsl(60, 9%, 87%);
|
|
||||||
--fg: #262625;
|
|
||||||
|
|
||||||
--sidebar-bg: #3b2e2a;
|
|
||||||
--sidebar-fg: #c8c9db;
|
|
||||||
--sidebar-non-existent: #505254;
|
|
||||||
--sidebar-active: #e69f67;
|
|
||||||
--sidebar-spacer: #45373a;
|
|
||||||
|
|
||||||
--scrollbar: var(--sidebar-fg);
|
|
||||||
|
|
||||||
--icons: #737480;
|
|
||||||
--icons-hover: #262625;
|
|
||||||
|
|
||||||
--links: #2b79a2;
|
|
||||||
|
|
||||||
--inline-code-color: #6e6b5e;
|
|
||||||
|
|
||||||
--theme-popup-bg: #e1e1db;
|
|
||||||
--theme-popup-border: #b38f6b;
|
|
||||||
--theme-hover: #99908a;
|
|
||||||
|
|
||||||
--quote-bg: hsl(60, 5%, 75%);
|
|
||||||
--quote-border: hsl(60, 5%, 70%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(60, 9%, 82%);
|
|
||||||
--table-header-bg: #b3a497;
|
|
||||||
--table-alternate-bg: hsl(60, 9%, 84%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #aaa;
|
|
||||||
--searchbar-bg: #fafafa;
|
|
||||||
--searchbar-fg: #000;
|
|
||||||
--searchbar-shadow-color: #aaa;
|
|
||||||
--searchresults-header-fg: #666;
|
|
||||||
--searchresults-border-color: #888;
|
|
||||||
--searchresults-li-bg: #dec2a2;
|
|
||||||
--search-mark-bg: #e69f67;
|
|
||||||
|
|
||||||
--color-scheme: light;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
|
||||||
.light.no-js {
|
|
||||||
--bg: hsl(200, 7%, 8%);
|
|
||||||
--fg: #98a3ad;
|
|
||||||
|
|
||||||
--sidebar-bg: #292c2f;
|
|
||||||
--sidebar-fg: #a1adb8;
|
|
||||||
--sidebar-non-existent: #505254;
|
|
||||||
--sidebar-active: #3473ad;
|
|
||||||
--sidebar-spacer: #393939;
|
|
||||||
|
|
||||||
--scrollbar: var(--sidebar-fg);
|
|
||||||
|
|
||||||
--icons: #43484d;
|
|
||||||
--icons-hover: #b3c0cc;
|
|
||||||
|
|
||||||
--links: #2b79a2;
|
|
||||||
|
|
||||||
--inline-code-color: #c5c8c6;
|
|
||||||
|
|
||||||
--theme-popup-bg: #141617;
|
|
||||||
--theme-popup-border: #43484d;
|
|
||||||
--theme-hover: #1f2124;
|
|
||||||
|
|
||||||
--quote-bg: hsl(234, 21%, 18%);
|
|
||||||
--quote-border: hsl(234, 21%, 23%);
|
|
||||||
|
|
||||||
--warning-border: #ff8e00;
|
|
||||||
|
|
||||||
--table-border-color: hsl(200, 7%, 13%);
|
|
||||||
--table-header-bg: hsl(200, 7%, 28%);
|
|
||||||
--table-alternate-bg: hsl(200, 7%, 11%);
|
|
||||||
|
|
||||||
--searchbar-border-color: #aaa;
|
|
||||||
--searchbar-bg: #b7b7b7;
|
|
||||||
--searchbar-fg: #000;
|
|
||||||
--searchbar-shadow-color: #aaa;
|
|
||||||
--searchresults-header-fg: #666;
|
|
||||||
--searchresults-border-color: #98a3ad;
|
|
||||||
--searchresults-li-bg: #2b2b2f;
|
|
||||||
--search-mark-bg: #355c7d;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
66
theme/index.css
Normal file
66
theme/index.css
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--rp-c-brand: #8a5cd0;
|
||||||
|
--rp-c-brand-light: oklch(from var(--rp-c-brand) 0.7197 c h);
|
||||||
|
--rp-c-brand-lighter: oklch(from var(--rp-c-brand) 0.7818 c h);
|
||||||
|
--rp-c-brand-dark: oklch(from var(--rp-c-brand) 0.5967 c h);
|
||||||
|
--rp-c-brand-darker: oklch(from var(--rp-c-brand) 0.5069 c h);
|
||||||
|
--rp-c-brand-tint: oklch(from var(--rp-c-brand) 0.4 c h);
|
||||||
|
|
||||||
|
--name-lightness: 0.45;
|
||||||
|
--c1: oklch(0.44 0.177 353.06);
|
||||||
|
--c2: oklch(0.59 0.158 150.88);
|
||||||
|
|
||||||
|
--rp-home-hero-name-background: linear-gradient(
|
||||||
|
130deg,
|
||||||
|
oklch(from var(--c1) var(--name-lightness) c h),
|
||||||
|
oklch(from var(--c2) var(--name-lightness) c h)
|
||||||
|
);
|
||||||
|
--rp-home-mask-background-image: conic-gradient(from 180deg at 50% 50%, var(--c1) 0deg, 180deg, var(--c2) 1turn);
|
||||||
|
|
||||||
|
/*--rp-c-bg: #ffffff;
|
||||||
|
--rp-c-bg-soft: oklch(0.91 0.042 317.27);
|
||||||
|
--rp-c-bg-mute: oklch(0.88 0.035 317.27);
|
||||||
|
--rp-c-bg-alt: #fff;*/
|
||||||
|
|
||||||
|
--rp-c-divider: rgba(0, 0, 0, 0.2);
|
||||||
|
--rp-c-divider-light: rgba(0, 0, 0, 0.1);
|
||||||
|
|
||||||
|
--rp-c-text-0: #000000;
|
||||||
|
--rp-c-text-1: #242424;
|
||||||
|
--rp-c-text-2: rgba(0, 0, 0, 0.7);
|
||||||
|
--rp-c-text-3: rgba(60, 60, 60, 0.33);
|
||||||
|
--rp-c-text-4: rgba(60, 60, 60, 0.18);
|
||||||
|
|
||||||
|
--rp-c-text-code: oklch(0.49 0.158 150.88);
|
||||||
|
--rp-c-text-code-bg: oklch(0.85 0.08 150.88 / 0.15);
|
||||||
|
|
||||||
|
--rp-c-link: oklch(0.49 0.158 150.88);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dark {
|
||||||
|
--name-lightness: 0.8;
|
||||||
|
|
||||||
|
--rp-c-bg: oklch(0.15 0.042 317.27);
|
||||||
|
--rp-c-bg-soft: oklch(0.24 0.03 317.27);
|
||||||
|
--rp-c-bg-mute: oklch(0.28 0.035 317.27);
|
||||||
|
--rp-c-bg-alt: #000;
|
||||||
|
|
||||||
|
--rp-c-divider: rgba(84, 84, 84, 0.65);
|
||||||
|
--rp-c-divider-light: rgba(84, 84, 84, 0.48);
|
||||||
|
|
||||||
|
--rp-c-text-0: #ffffff;
|
||||||
|
--rp-c-text-1: rgba(255, 255, 245, 0.93);
|
||||||
|
--rp-c-text-2: rgba(255, 255, 245, 0.65);
|
||||||
|
--rp-c-text-3: rgba(235, 235, 235, 0.38);
|
||||||
|
--rp-c-text-4: rgba(235, 235, 235, 0.18);
|
||||||
|
|
||||||
|
--rp-c-text-code: oklch(0.8 0.158 150.88);
|
||||||
|
--rp-c-text-code-bg: oklch(0.59 0.158 150.88 / 0.15);
|
||||||
|
|
||||||
|
--rp-c-link: oklch(0.69 0.158 150.88);
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
display: inline-block
|
||||||
|
}
|
||||||
3
theme/index.tsx
Normal file
3
theme/index.tsx
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
import './index.css';
|
||||||
|
export * from '@rspress/core/theme';
|
||||||
|
console.log("s")
|
||||||
27
tsconfig.json
Normal file
27
tsconfig.json
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"lib": ["DOM", "ES2020"],
|
||||||
|
"jsx": "react-jsx",
|
||||||
|
"target": "ES2020",
|
||||||
|
"noEmit": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"useDefineForClassFields": true,
|
||||||
|
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleDetection": "force",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"noUncheckedSideEffectImports": true,
|
||||||
|
"isolatedModules": true,
|
||||||
|
|
||||||
|
"strict": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true
|
||||||
|
},
|
||||||
|
"include": ["docs", "theme", "rspress.config.ts"],
|
||||||
|
"mdx": {
|
||||||
|
"checkMdx": true
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue