mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
123 lines
4.0 KiB
YAML
123 lines
4.0 KiB
YAML
docs_dir: markdown
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: overrides
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
palette:
|
|
- media: '(prefers-color-scheme: light)'
|
|
scheme: default
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
primary: deep purple
|
|
accent: deep orange
|
|
|
|
# Palette toggle for dark mode
|
|
- media: '(prefers-color-scheme: dark)'
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
primary: deep purple
|
|
accent: deep orange
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tabs
|
|
- navigation.top
|
|
- navigation.indexes
|
|
|
|
site_name: Community Solid Server
|
|
site_url: https://communitysolidserver.github.io/CommunitySolidServer
|
|
|
|
repo_url: https://github.com/CommunitySolidServer/CommunitySolidServer
|
|
repo_name: CommunitySolidServer
|
|
edit_uri: ''
|
|
|
|
plugins:
|
|
- search
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- def_list
|
|
- footnotes
|
|
- meta
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.tilde
|
|
- pymdownx.details
|
|
- pymdownx.highlight
|
|
- pymdownx.superfences
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
# Need to fork the theme to make changes https://github.com/squidfunk/mkdocs-material/issues/3665#issuecomment-1060019924
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/CommunitySolidServer/CommunitySolidServer
|
|
- icon: fontawesome/brands/docker
|
|
link: https://hub.docker.com/r/solidproject/community-server
|
|
- icon: fontawesome/brands/npm
|
|
link: https://www.npmjs.com/package/@solid/community-server
|
|
- icon: fontawesome/brands/gitter
|
|
link: https://gitter.im/CommunitySolidServer/community
|
|
|
|
nav:
|
|
- Welcome:
|
|
- README.md
|
|
- Features:
|
|
- Overview: features.md
|
|
- Tests: features/test.md
|
|
- Usage:
|
|
- Starting the server: usage/starting-server.md
|
|
- Example request: usage/example-requests.md
|
|
- Metadata: usage/metadata.md
|
|
- Identity provider:
|
|
- Overview: usage/identity-provider.md
|
|
- JSON API: usage/account/json-api.md
|
|
- New login method: usage/account/login-method.md
|
|
- Data migration: usage/account/migration.md
|
|
- Client credentials: usage/client-credentials.md
|
|
- Seeding pods: usage/seeding-pods.md
|
|
- Notifications: usage/notifications.md
|
|
- Development server: usage/dev-configuration.md
|
|
- Authorization methods: usage/authorization-methods.md
|
|
- Architecture:
|
|
- Overview: architecture/overview.md
|
|
- Dependency injection: architecture/dependency-injection.md
|
|
- Core: architecture/core.md
|
|
- Features:
|
|
- Command line arguments: architecture/features/cli.md
|
|
- Server initialization: architecture/features/initialization.md
|
|
- HTTP requests: architecture/features/http-handler.md
|
|
- Solid protocol:
|
|
- Overview: architecture/features/protocol/overview.md
|
|
- Parsing: architecture/features/protocol/parsing.md
|
|
- Authorization: architecture/features/protocol/authorization.md
|
|
- Resource Store: architecture/features/protocol/resource-store.md
|
|
- Modifying resources: architecture/features/protocol/patching.md
|
|
- Account management:
|
|
- Overview: architecture/features/accounts/overview.md
|
|
- Controls: architecture/features/accounts/controls.md
|
|
- Routes: architecture/features/accounts/routes.md
|
|
- Notifications: architecture/features/notifications.md
|
|
- Contributing:
|
|
- Pull requests: contributing/making-changes.md
|
|
- Releases: contributing/release.md
|
|
- API: ./docs/" target="_blank
|
|
|
|
# To write documentation locally, execute the next line and browse to http://localhost:8000
|
|
# npm run mkdocs
|