vishiri/fantasia-markdown-dialogs

Fantasia Archive — markdown dialogs

Components

• DialogMarkdownDocument.vue: Renders markdown via QMarkdown from @quasar/quasar-ui-qmarkdown with the package CSS imported alongside the component.
• Dialog flow is tied to Pinia dialog state (src/stores/S_Dialog.ts) and helpers in src/scripts/appGlobalManagementUI/dialogManagement.ts (for example openDialogMarkdownDocument). The root q-dialog model calls registerMarkdownDialogStackGuard from that module so markdownDialogOpenCount stays aligned when the dialog closes or the host unmounts.

Content source

• Long-form markdown files live under i18n/en-US/documents/ (and parallel locales) and are registered on the documents key in i18n/en-US/index.ts (often through specialCharacterFixer).
• Storybook-specific runs should not import those markdown files through full locale entrypoints by default; provide placeholder documents.* strings in .storybook-workspace/.storybook/preview.ts unless Storybook markdown loader support is explicitly configured.

Conventions

• Prefer updating .md assets and i18n wiring over hardcoding large markdown in .vue files.
• Keep headings and structure readable in a modal/dialog viewport; test in the actual dialog component.
• Markdown under i18n/*/documents/ is compiled as vue-i18n message text: do not use stray {...} (for example glob .*.{ext1,ext2}) unless you follow vue-i18n placeholder rules — invalid groups break the changelog and other document dialogs at runtime. See fantasia-changelog-en-us for changelog-specific wording.

Related

• fantasia-i18n for locale layout and documents registration.

TypeScript interfaces and types (types/)

• Put shared interface / type declarations in repository-root types/ (import with app/types/...). Prefer one domain-oriented module per feature area with brief JSDoc on exports (see types/I_appMenusDataList.ts). Do not add colocated <filename>.types.ts under src/, src-electron/, or .storybook-workspace/. Ambient augmentations for third-party modules also live under types/ and are loaded with a side-effect import from the owning boot file or src/stores/index.ts (see types/piniaModuleAugmentation.ts).
• For JavaScript (.js), TypeScript (.ts), Vue (.vue), and JSON (.json, .jsonc, .json5) files, enforce expanded multi-line object literals via ESLint (object-curly-newline + object-property-newline) and keep files auto-fixable with eslint --fix.