mirror of
https://github.com/go-shiori/shiori.git
synced 2025-09-08 14:05:54 +08:00
bb7bfcc2c2
* refactor: Migrate documentation to MkDocs with material theme and improved structure * refactor: docs images hierarchy * refactor: Move screenshots to assets and update paths in Screenshots.md * feat: Convert screenshots to MkDocs content tabs with light/dark theme switching * feat: sync content tabs by label * chore: add light theme with shiori red color * docs: Update index page to match README with concise feature list * docs: Remove Resources section from documentation index * ci: added github workflows * docs: Add section for building documentation in Contribute.md
54 lines
1.2 KiB
YAML
54 lines
1.2 KiB
YAML
site_name: Shiori Documentation
|
|
site_description: Documentation for the Shiori bookmark manager
|
|
repo_url: https://github.com/go-shiori/shiori
|
|
theme:
|
|
name: material
|
|
palette:
|
|
# Light mode
|
|
- scheme: shiori
|
|
media: "(prefers-color-scheme: light)"
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- scheme: slate
|
|
media: "(prefers-color-scheme: dark)"
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.indexes
|
|
- toc.follow
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.tabs.link
|
|
extra_css:
|
|
- assets/css/style.css
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: installation.md
|
|
- Usage: usage.md
|
|
- Configuration: configuration.md
|
|
- Storage: storage.md
|
|
- API Reference:
|
|
- API v1: apiv1.md
|
|
- Legacy API: api.md
|
|
- Contributing:
|
|
- Contributing Guide: contribute.md
|
|
- FAQ: faq.md
|
|
- Screenshots: screenshots.md
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|