How kalen5241/markdownpreviewer works
File structure
Top-level directories and files:
• src/ – the Vue application source
– main.js: application entry point
– App.vue: root component
– views/: individual screens (Form.vue, StringSplitter.vue, etc.)
– js/katex-parser.js: custom math parser
– locales/: JSON files for en, ja, zh + i18n setup
– assets/main.css: global styles
• public/ – static assets copied verbatim to the build
• lark-help/ – Markdown help content under help-md/ and TypeScript definitions under help-ts/
• dist/ – Vite’s build output (index.html + compiled JS/CSS assets)
• vite.config.js, tsconfig*.json, package.json – build and tooling configuration
README
• Confirms the project name (“MarkdownPreviewer”) and purpose (“Markdown 预览器” i.e., “Markdown previewer”). No extra architecture notes.
Elements
• Clear labels for:
– Developer Machine & Build System
– Static Hosting / CDN
– Browser (Application Runtime)
– Source code → build → dist/ → hosting → browser
– User input → Vue components → parser modules → rendered output
Final advice
• The goal is to reflect precisely what lives in src/, what gets bundled, where it’s hosted, and how it flows at runtime in the browser.