Skip to content

Add professional wiki documentation#39

Merged
ThisIs-Developer merged 2 commits intomainfrom
copilot/create-project-wiki
Mar 7, 2026
Merged

Add professional wiki documentation#39
ThisIs-Developer merged 2 commits intomainfrom
copilot/create-project-wiki

Conversation

Copy link
Contributor

Copilot AI commented Mar 7, 2026

The project lacked structured reference documentation beyond a single README, making it hard for new users, contributors, and operators to find targeted information.

Added wiki/ directory with 9 pages

  • Home.md — Entry point: quick-start table, feature highlights, tech stack, page index
  • Installation.md — All deployment paths: Docker one-liner, Docker Compose, bare static server, desktop binary
  • Usage-Guide.md — Editor, import/export, view modes, sync scroll, share-via-URL, keyboard shortcuts
  • Features.md — Per-feature deep-dives: syntax highlighting, LaTeX/MathJax, Mermaid diagrams, privacy/XSS model
  • Markdown-Reference.md — Full CommonMark + GFM syntax reference; includes LaTeX and Mermaid examples
  • Desktop-App.md — Neutralinojs architecture, dev setup, all three build modes, CI release flow, per-platform run notes
  • Docker-Deployment.md — Docker run/compose, embedded Nginx config, reverse-proxy snippets (Nginx, Caddy, Traefik)
  • Contributing.md — HTML/CSS/JS style guidelines, Conventional Commits reference, branch/PR workflow
  • Configuration.md — Complete settings reference: localStorage keys, Docker/Nginx tunables, neutralino.config.json fields, GitHub Actions trigger matrix
  • FAQ.md — 25+ Q&As covering general use, features, offline support, troubleshooting, and contribution

No source files modified.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@vercel
Copy link

vercel bot commented Mar 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
markdown-viwer Ready Ready Preview, Comment Mar 7, 2026 5:39pm

Co-authored-by: ThisIs-Developer <109382325+ThisIs-Developer@users.noreply.github.com>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 7, 2026

Deploying markdown-viewer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 435c24d
Status: ✅  Deploy successful!
Preview URL: https://af1d8fb6.markdown-viewer.pages.dev
Branch Preview URL: https://copilot-create-project-wiki.markdown-viewer.pages.dev

View logs

Copilot AI changed the title [WIP] Add professional wiki for project Add professional wiki documentation Mar 7, 2026
@cloudflare-workers-and-pages
Copy link

Deploying markdownviewer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 435c24d
Status: ✅  Deploy successful!
Preview URL: https://12870233.markdownviewer.pages.dev
Branch Preview URL: https://copilot-create-project-wiki.markdownviewer.pages.dev

View logs

@ThisIs-Developer ThisIs-Developer marked this pull request as ready for review March 7, 2026 18:15
@ThisIs-Developer ThisIs-Developer merged commit 01effc7 into main Mar 7, 2026
6 checks passed
@ThisIs-Developer ThisIs-Developer deleted the copilot/create-project-wiki branch March 9, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants