Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-03 20:06:08 +01:00
Code Issues Packages Projects Releases Activity

feat(docs): try to get mkdocs to work again

Browse Source
This commit is contained in:
perf3ct
2025-09-04 21:20:01 +00:00
parent dad060d0c9
commit fcd2409ee3
3 changed files with 89 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/workflows/deploy-docs.yml vendored
View File

@@ -86,6 +86,12 @@ jobs:
test -d site/assets || (echo "ERROR: site/assets directory not found" && exit 1) test -d site/assets || (echo "ERROR: site/assets directory not found" && exit 1)
echo "✅ Site validation passed" echo "✅ Site validation passed"
# Setup Node.js for Wrangler
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
# Deploy using Wrangler (recommended by Cloudflare) # Deploy using Wrangler (recommended by Cloudflare)
- name: Deploy to Cloudflare Pages - name: Deploy to Cloudflare Pages
id: deploy id: deploy
@@ -95,6 +101,7 @@ jobs:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
command: pages deploy site --project-name=trilium-docs --branch=${{ github.ref_name }} command: pages deploy site --project-name=trilium-docs --branch=${{ github.ref_name }}
packageManager: npm # Explicitly use npm instead of pnpm
# Deploy preview for PRs # Deploy preview for PRs
- name: Deploy Preview to Cloudflare Pages - name: Deploy Preview to Cloudflare Pages
@@ -105,6 +112,7 @@ jobs:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
command: pages deploy site --project-name=trilium-docs --branch=pr-${{ github.event.pull_request.number }} command: pages deploy site --project-name=trilium-docs --branch=pr-${{ github.event.pull_request.number }}
packageManager: npm # Explicitly use npm instead of pnpm
# Post deployment URL as PR comment # Post deployment URL as PR comment
- name: Comment PR with Preview URL - name: Comment PR with Preview URL

12
docs/README.md vendored Normal file
View File

@@ -0,0 +1,12 @@
# Trilium Notes
Please see the [main documentation](index.md) or visit one of our translated versions:
- [Español](README.es.md)
- [Italiano](README.it.md)
- [日本語](README.ja.md)
- [Русский](README.ru.md)
- [简体中文](README-ZH_CN.md)
- [繁體中文](README-ZH_TW.md)
For the full application README, please visit our [GitHub repository](https://github.com/triliumnext/trilium).

145
mkdocs.yml
View File

@@ -178,90 +178,85 @@ extra:
provider: mike provider: mike
default: stable default: stable
# Navigation structure based on existing documentation # Navigation structure matching actual file paths
nav: nav:
- Home: index.md - Home: index.md
- Introduction: README.md
- Getting Started: - Getting Started:
- Introduction: README.md - Quick Start: User Guide/User Guide/Quick Start.md
- Installation: - Installation:
- Desktop Installation: User Guide/installation.md - Desktop Installation: User Guide/User Guide/Installation & Setup/Desktop Installation.md
- Server Installation: User Guide/server-installation.md - Server Installation: User Guide/User Guide/Installation & Setup/Server Installation.md
- Docker Installation: User Guide/docker.md - Docker: User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md
- Mobile Access: User Guide/mobile-frontend.md - Mobile Frontend: User Guide/User Guide/Installation & Setup/Mobile Frontend.md
- Quick Start Guide: User Guide/quick-start.md
- User Guide: - User Guide:
- Overview: User Guide/index.md - Overview: User Guide/User Guide.md
- Feature Highlights: User Guide/User Guide/Feature Highlights.md
- Basic Concepts: - Basic Concepts:
- Notes & Branches: User Guide/notes-and-branches.md - Notes: User Guide/User Guide/Basic Concepts and Features/Notes.md
- Note Types: User Guide/note-types.md - Keyboard Shortcuts: User Guide/User Guide/Basic Concepts and Features/Keyboard Shortcuts.md
- Attributes: User Guide/attributes.md - Themes: User Guide/User Guide/Basic Concepts and Features/Themes.md
- Relations: User Guide/relations.md - Zen Mode: User Guide/User Guide/Basic Concepts and Features/Zen mode.md
- Features: - Navigation:
- Note Editor: User Guide/note-editor.md - Search: User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md
- Search: User Guide/search.md - Quick Search: User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.md
- Note Map: User Guide/note-map.md - Tree Concepts: User Guide/User Guide/Basic Concepts and Features/Navigation/Tree Concepts.md
- Day Notes: User Guide/day-notes.md - Note Navigation: User Guide/User Guide/Basic Concepts and Features/Navigation/Note Navigation.md
- Book Notes: User Guide/book-notes.md - Bookmarks: User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md
- Templates: User Guide/templates.md - Workspaces: User Guide/User Guide/Basic Concepts and Features/Navigation/Workspaces.md
- Cloning Notes: User Guide/cloning-notes.md - Note Types:
- Protected Notes: User Guide/protected-notes.md - Overview: User Guide/User Guide/Note Types.md
- Note Revisions: User Guide/note-revisions.md - Text: User Guide/User Guide/Note Types/Text.md
- Synchronization: User Guide/synchronization.md - Code: User Guide/User Guide/Note Types/Code.md
- Advanced Features: - Canvas: User Guide/User Guide/Note Types/Canvas.md
- Scripting: User Guide/scripting.md - File: User Guide/User Guide/Note Types/File.md
- Themes: User Guide/themes.md - Mermaid Diagrams: User Guide/User Guide/Note Types/Mermaid Diagrams.md
- Keyboard Shortcuts: User Guide/keyboard-shortcuts.md - Mind Map: User Guide/User Guide/Note Types/Mind Map.md
- Web Clipper: User Guide/web-clipper.md - Collections: User Guide/User Guide/Note Types/Collections.md
- Import & Export: User Guide/import-export.md - Advanced Usage:
- Backup: User Guide/backup.md - Attributes: User Guide/User Guide/Advanced Usage/Attributes.md
- Configuration: User Guide/configuration.md - Templates: User Guide/User Guide/Advanced Usage/Templates.md
- Sharing: User Guide/User Guide/Advanced Usage/Sharing.md
- Script API: - Database: User Guide/User Guide/Advanced Usage/Database.md
- Overview: Script API/index.md - ETAPI: User Guide/User Guide/Advanced Usage/ETAPI (REST API).md
- Backend API: - Installation & Setup:
- Overview: Script API/backend/index.md - Backup: User Guide/User Guide/Installation & Setup/Backup.md
- BNote: Script API/backend/BNote.md - Synchronization: User Guide/User Guide/Installation & Setup/Synchronization.md
- BBranch: Script API/backend/BBranch.md - Web Clipper: User Guide/User Guide/Installation & Setup/Web Clipper.md
- BAttribute: Script API/backend/BAttribute.md - Data Directory: User Guide/User Guide/Installation & Setup/Data directory.md
- BackendScriptApi: Script API/backend/BackendScriptApi.md - Scripting:
- SQL API: Script API/backend/sql.md - Overview: User Guide/User Guide/Scripting.md
- Frontend API: - Script API: User Guide/User Guide/Scripting/Script API.md
- Overview: Script API/frontend/index.md - Custom Widgets: User Guide/User Guide/Scripting/Custom Widgets.md
- FNote: Script API/frontend/FNote.md - Events: User Guide/User Guide/Scripting/Events.md
- FBranch: Script API/frontend/FBranch.md - Troubleshooting:
- FAttribute: Script API/frontend/FAttribute.md - Overview: User Guide/User Guide/Troubleshooting.md
- FrontendScriptApi: Script API/frontend/FrontendScriptApi.md - Error Logs: User Guide/User Guide/Troubleshooting/Error logs.md
- Examples: - FAQ: User Guide/User Guide/FAQ.md
- Script Examples: Script API/examples.md
- Custom Widgets: Script API/custom-widgets.md
- Event Handlers: Script API/event-handlers.md
- Developer Guide: - Developer Guide:
- Overview: Developer Guide/index.md - Environment Setup: Developer Guide/Developer Guide/Environment Setup.md
- Architecture: - Project Structure: Developer Guide/Developer Guide/Project Structure.md
- Project Structure: Developer Guide/architecture.md - Development:
- Database Schema: Developer Guide/database.md - Icons: Developer Guide/Developer Guide/Development and architecture/Icons.md
- Entity System: Developer Guide/entities.md - Options: Developer Guide/Developer Guide/Development and architecture/Options.md
- Cache System: Developer Guide/cache-system.md - Themes: Developer Guide/Developer Guide/Development and architecture/Themes.md
- Development Setup: - Database Tables:
- Local Development: Developer Guide/development.md - Notes: Developer Guide/Developer Guide/Development and architecture/Database/notes.md
- Building from Source: Developer Guide/build.md - Attributes: Developer Guide/Developer Guide/Development and architecture/Database/attributes.md
- Testing: Developer Guide/testing.md - Branches: Developer Guide/Developer Guide/Development and architecture/Database/branches.md
- Contributing:
- Contribution Guide: Developer Guide/contributing.md - Script API Documentation:
- Code Style: Developer Guide/code-style.md - API Reference: Script API/index.html
- Creating Plugins: Developer Guide/plugins.md
- API Development:
- REST API: Developer Guide/rest-api.md
- ETAPI: Developer Guide/etapi.md
- WebSocket API: Developer Guide/websocket.md
- Release Notes: - Release Notes:
- Latest Release: Release Notes/latest.md - v0.98.1: Release Notes/Release Notes/v0.98.1.md
- Version History: Release Notes/history.md - v0.98.0: Release Notes/Release Notes/v0.98.0.md
- Migration Guides: Release Notes/migration.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: - Translations:
- Español: README.es.md - Español: README.es.md
@@ -272,7 +267,5 @@ nav:
- 繁體中文: README-ZH_TW.md - 繁體中文: README-ZH_TW.md
- Support: - Support:
- FAQ: support/faq.md - GitHub Issues: https://github.com/triliumnext/trilium/issues
- Troubleshooting: support/troubleshooting.md - Discussions: https://github.com/triliumnext/trilium/discussions
- Community: support/community.md
- Issue Tracker: https://github.com/zadam/trilium/issues