From fcd2409ee35a4092e56a5d3bc9661e41465cc08c Mon Sep 17 00:00:00 2001 From: perf3ct Date: Thu, 4 Sep 2025 21:20:01 +0000 Subject: [PATCH] feat(docs): try to get mkdocs to work again --- .github/workflows/deploy-docs.yml | 8 ++ docs/README.md | 12 +++ mkdocs.yml | 145 ++++++++++++++---------------- 3 files changed, 89 insertions(+), 76 deletions(-) create mode 100644 docs/README.md diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 25b04d1d7..3a1342f56 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -86,6 +86,12 @@ jobs: test -d site/assets || (echo "ERROR: site/assets directory not found" && exit 1) 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) - name: Deploy to Cloudflare Pages id: deploy @@ -95,6 +101,7 @@ jobs: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} command: pages deploy site --project-name=trilium-docs --branch=${{ github.ref_name }} + packageManager: npm # Explicitly use npm instead of pnpm # Deploy preview for PRs - name: Deploy Preview to Cloudflare Pages @@ -105,6 +112,7 @@ jobs: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} 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 - name: Comment PR with Preview URL diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..5675758ee --- /dev/null +++ b/docs/README.md @@ -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). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ecde11abb..d000e4de9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -178,90 +178,85 @@ extra: provider: mike default: stable -# Navigation structure based on existing documentation +# Navigation structure matching actual file paths nav: - Home: index.md + - Introduction: README.md - Getting Started: - - Introduction: README.md + - Quick Start: User Guide/User Guide/Quick Start.md - Installation: - - Desktop Installation: User Guide/installation.md - - Server Installation: User Guide/server-installation.md - - Docker Installation: User Guide/docker.md - - Mobile Access: User Guide/mobile-frontend.md - - Quick Start Guide: User Guide/quick-start.md + - 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/index.md + - Overview: User Guide/User Guide.md + - Feature Highlights: User Guide/User Guide/Feature Highlights.md - Basic Concepts: - - Notes & Branches: User Guide/notes-and-branches.md - - Note Types: User Guide/note-types.md - - Attributes: User Guide/attributes.md - - Relations: User Guide/relations.md - - Features: - - Note Editor: User Guide/note-editor.md - - Search: User Guide/search.md - - Note Map: User Guide/note-map.md - - Day Notes: User Guide/day-notes.md - - Book Notes: User Guide/book-notes.md - - Templates: User Guide/templates.md - - Cloning Notes: User Guide/cloning-notes.md - - Protected Notes: User Guide/protected-notes.md - - Note Revisions: User Guide/note-revisions.md - - Synchronization: User Guide/synchronization.md - - Advanced Features: - - Scripting: User Guide/scripting.md - - Themes: User Guide/themes.md - - Keyboard Shortcuts: User Guide/keyboard-shortcuts.md - - Web Clipper: User Guide/web-clipper.md - - Import & Export: User Guide/import-export.md - - Backup: User Guide/backup.md - - Configuration: User Guide/configuration.md - - - Script API: - - Overview: Script API/index.md - - Backend API: - - Overview: Script API/backend/index.md - - BNote: Script API/backend/BNote.md - - BBranch: Script API/backend/BBranch.md - - BAttribute: Script API/backend/BAttribute.md - - BackendScriptApi: Script API/backend/BackendScriptApi.md - - SQL API: Script API/backend/sql.md - - Frontend API: - - Overview: Script API/frontend/index.md - - FNote: Script API/frontend/FNote.md - - FBranch: Script API/frontend/FBranch.md - - FAttribute: Script API/frontend/FAttribute.md - - FrontendScriptApi: Script API/frontend/FrontendScriptApi.md - - Examples: - - Script Examples: Script API/examples.md - - Custom Widgets: Script API/custom-widgets.md - - Event Handlers: Script API/event-handlers.md + - 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: - - Overview: Developer Guide/index.md - - Architecture: - - Project Structure: Developer Guide/architecture.md - - Database Schema: Developer Guide/database.md - - Entity System: Developer Guide/entities.md - - Cache System: Developer Guide/cache-system.md - - Development Setup: - - Local Development: Developer Guide/development.md - - Building from Source: Developer Guide/build.md - - Testing: Developer Guide/testing.md - - Contributing: - - Contribution Guide: Developer Guide/contributing.md - - Code Style: Developer Guide/code-style.md - - 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 + - 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: - - Latest Release: Release Notes/latest.md - - Version History: Release Notes/history.md - - Migration Guides: Release Notes/migration.md + - 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 @@ -272,7 +267,5 @@ nav: - 繁體中文: README-ZH_TW.md - Support: - - FAQ: support/faq.md - - Troubleshooting: support/troubleshooting.md - - Community: support/community.md - - Issue Tracker: https://github.com/zadam/trilium/issues + - GitHub Issues: https://github.com/triliumnext/trilium/issues + - Discussions: https://github.com/triliumnext/trilium/discussions