mirror of
https://github.com/zadam/trilium.git
synced 2025-11-01 20:19:05 +01:00
chore: remove remaining references to mkdocs
This commit is contained in:
Elian Doran
parent
28c0e4e802
commit
1822eea77c
15
.github/workflows/deploy-docs.yml
vendored
15
.github/workflows/deploy-docs.yml
vendored
@ -1,6 +1,4 @@
|
||||
# GitHub Actions workflow for deploying MkDocs documentation to Cloudflare Pages
|
||||
# This workflow builds and deploys your MkDocs site when changes are pushed to main
|
||||
name: Deploy MkDocs Documentation
|
||||
name: Deploy Documentation
|
||||
|
||||
on:
|
||||
# Trigger on push to main branch
|
||||
@ -24,15 +22,12 @@ on:
|
||||
- master
|
||||
paths:
|
||||
- 'docs/**'
|
||||
- 'README.md' # README is synced to docs/index.md
|
||||
- 'mkdocs.yml'
|
||||
- 'requirements-docs.txt'
|
||||
- '.github/workflows/deploy-docs.yml'
|
||||
- 'scripts/fix-mkdocs-structure.ts'
|
||||
- 'apps/edit-docs/**'
|
||||
- 'packages/share-theme/**'
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
name: Build and Deploy MkDocs
|
||||
name: Build and Deploy Documentation
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
|
||||
@ -46,8 +41,6 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
fetch-depth: 0 # Fetch all history for git info and mkdocs-git-revision-date plugin
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
191
mkdocs.yml
191
mkdocs.yml
@ -1,191 +0,0 @@
|
||||
# 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
|
||||
|
||||
# Use document-style URLs to fix image paths
|
||||
use_directory_urls: false
|
||||
|
||||
# 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
|
||||
- awesome-pages:
|
||||
collapse_single_pages: false
|
||||
strict: false
|
||||
order: asc
|
||||
sort_type: natural
|
||||
order_by: title
|
||||
- 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/triliumnext/trilium
|
||||
- icon: fontawesome/brands/docker
|
||||
link: https://hub.docker.com/r/triliumnext/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/triliumnext/trilium/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">opening an issue</a>.
|
||||
|
||||
# Version
|
||||
version:
|
||||
provider: mike
|
||||
default: stable
|
||||
|
||||
# Navigation is automatically generated from folder structure by awesome-pages plugin
|
||||
# To customize order or titles, create .pages files in directories
|
||||
@ -1,21 +0,0 @@
|
||||
# MkDocs and Material theme requirements for Trilium documentation
|
||||
mkdocs>=1.6.0
|
||||
mkdocs-material>=9.5.0
|
||||
mkdocs-material-extensions>=1.3.0
|
||||
|
||||
# Essential plugins
|
||||
mkdocs-awesome-pages-plugin>=2.9.0 # Auto-generate navigation from folder structure
|
||||
mkdocs-minify-plugin>=0.8.0
|
||||
mkdocs-git-revision-date-localized-plugin>=1.2.0
|
||||
|
||||
# Optional but recommended plugins
|
||||
mkdocs-redirects>=1.2.0
|
||||
mkdocs-rss-plugin>=1.12.0
|
||||
mkdocs-glightbox>=0.3.0
|
||||
|
||||
# For advanced features
|
||||
pillow>=10.0.0 # For social cards generation
|
||||
cairosvg>=2.7.0 # For social cards with SVG support
|
||||
|
||||
# Search enhancements
|
||||
mkdocs-material[imaging]>=9.5.0
|
||||
Loading…
x
Reference in New Issue
Block a user