trilium/mkdocs.yml

272 lines
9.2 KiB
YAML

# MkDocs configuration for Trilium Notes documentation
site_name: Trilium Notes Documentation
site_url: https://docs.triliumnext.com
site_description: Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases
site_author: Trilium Notes Team
# Repository information
repo_name: triliumnext/trilium
repo_url: https://github.com/triliumnext/trilium
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2025 Trilium Notes
# Theme configuration
theme:
name: material
# Color scheme
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: deep-purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue-grey
accent: deep-purple
toggle:
icon: material/brightness-4
name: Switch to light mode
# Font configuration
font:
text: Inter
code: JetBrains Mono
# Features
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
# Icons
icon:
logo: material/note-multiple
repo: fontawesome/brands/github
# Plugins
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
lang:
- en
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
- git-revision-date-localized:
enable_creation_date: true
type: iso_datetime
fallback_to_build_date: true
# Extensions
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
permalink_title: Anchor link to this section for reference
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Extra CSS and JavaScript (if needed)
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/extra.js
# MathJax for mathematical notation
- javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
# Extra configuration
extra:
# Social links
social:
- icon: fontawesome/brands/github
link: https://github.com/zadam/trilium
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/zadam/trilium
- icon: fontawesome/solid/globe
link: https://trilium.cc
# Analytics (optional - add your own if needed)
analytics:
provider: google
property: G-XXXXXXXXXX # Replace with your Google Analytics ID
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
<a href="https://github.com/zadam/trilium/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">opening an issue</a>.
# Version
version:
provider: mike
default: stable
# Navigation structure matching actual file paths
nav:
- Home: index.md
- Introduction: README.md
- Getting Started:
- Quick Start: User Guide/User Guide/Quick Start.md
- Installation:
- Desktop Installation: User Guide/User Guide/Installation & Setup/Desktop Installation.md
- Server Installation: User Guide/User Guide/Installation & Setup/Server Installation.md
- Docker: User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md
- Mobile Frontend: User Guide/User Guide/Installation & Setup/Mobile Frontend.md
- User Guide:
- Overview: User Guide/User Guide.md
- Feature Highlights: User Guide/User Guide/Feature Highlights.md
- Basic Concepts:
- Notes: User Guide/User Guide/Basic Concepts and Features/Notes.md
- Keyboard Shortcuts: User Guide/User Guide/Basic Concepts and Features/Keyboard Shortcuts.md
- Themes: User Guide/User Guide/Basic Concepts and Features/Themes.md
- Zen Mode: User Guide/User Guide/Basic Concepts and Features/Zen mode.md
- Navigation:
- Search: User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md
- Quick Search: User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.md
- Tree Concepts: User Guide/User Guide/Basic Concepts and Features/Navigation/Tree Concepts.md
- Note Navigation: User Guide/User Guide/Basic Concepts and Features/Navigation/Note Navigation.md
- Bookmarks: User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md
- Workspaces: User Guide/User Guide/Basic Concepts and Features/Navigation/Workspaces.md
- Note Types:
- Overview: User Guide/User Guide/Note Types.md
- Text: User Guide/User Guide/Note Types/Text.md
- Code: User Guide/User Guide/Note Types/Code.md
- Canvas: User Guide/User Guide/Note Types/Canvas.md
- File: User Guide/User Guide/Note Types/File.md
- Mermaid Diagrams: User Guide/User Guide/Note Types/Mermaid Diagrams.md
- Mind Map: User Guide/User Guide/Note Types/Mind Map.md
- Collections: User Guide/User Guide/Note Types/Collections.md
- Advanced Usage:
- Attributes: User Guide/User Guide/Advanced Usage/Attributes.md
- Templates: User Guide/User Guide/Advanced Usage/Templates.md
- Sharing: User Guide/User Guide/Advanced Usage/Sharing.md
- Database: User Guide/User Guide/Advanced Usage/Database.md
- ETAPI: User Guide/User Guide/Advanced Usage/ETAPI (REST API).md
- Installation & Setup:
- Backup: User Guide/User Guide/Installation & Setup/Backup.md
- Synchronization: User Guide/User Guide/Installation & Setup/Synchronization.md
- Web Clipper: User Guide/User Guide/Installation & Setup/Web Clipper.md
- Data Directory: User Guide/User Guide/Installation & Setup/Data directory.md
- Scripting:
- Overview: User Guide/User Guide/Scripting.md
- Script API: User Guide/User Guide/Scripting/Script API.md
- Custom Widgets: User Guide/User Guide/Scripting/Custom Widgets.md
- Events: User Guide/User Guide/Scripting/Events.md
- Troubleshooting:
- Overview: User Guide/User Guide/Troubleshooting.md
- Error Logs: User Guide/User Guide/Troubleshooting/Error logs.md
- FAQ: User Guide/User Guide/FAQ.md
- Developer Guide:
- Environment Setup: Developer Guide/Developer Guide/Environment Setup.md
- Project Structure: Developer Guide/Developer Guide/Project Structure.md
- Development:
- Icons: Developer Guide/Developer Guide/Development and architecture/Icons.md
- Options: Developer Guide/Developer Guide/Development and architecture/Options.md
- Themes: Developer Guide/Developer Guide/Development and architecture/Themes.md
- Database Tables:
- Notes: Developer Guide/Developer Guide/Development and architecture/Database/notes.md
- Attributes: Developer Guide/Developer Guide/Development and architecture/Database/attributes.md
- Branches: Developer Guide/Developer Guide/Development and architecture/Database/branches.md
- Script API Documentation:
- API Reference: Script API/index.html
- Release Notes:
- v0.98.1: Release Notes/Release Notes/v0.98.1.md
- v0.98.0: Release Notes/Release Notes/v0.98.0.md
- v0.97.2: Release Notes/Release Notes/v0.97.2.md
- v0.97.1: Release Notes/Release Notes/v0.97.1.md
- v0.97.0: Release Notes/Release Notes/v0.97.0.md
- Translations:
- Español: README.es.md
- Italiano: README.it.md
- 日本語: README.ja.md
- Русский: README.ru.md
- 简体中文: README-ZH_CN.md
- 繁體中文: README-ZH_TW.md
- Support:
- GitHub Issues: https://github.com/triliumnext/trilium/issues
- Discussions: https://github.com/triliumnext/trilium/discussions