@mdwrk/mdwrkcom-content-pack 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/content/pages/answers/does-mdwrk-require-a-server.md +27 -0
- package/content/pages/answers/how-do-mdwrk-theme-packs-work.md +27 -0
- package/content/pages/answers/how-does-mdwrk-store-markdown-locally.md +27 -0
- package/content/pages/answers/index.md +39 -0
- package/content/pages/answers/what-is-a-local-first-markdown-workspace.md +27 -0
- package/content/pages/answers/what-is-an-offline-markdown-editor.md +27 -0
- package/content/pages/blog/launch.md +42 -0
- package/content/pages/compare/index.md +39 -0
- package/content/pages/compare/local-first-markdown-editors.md +27 -0
- package/content/pages/compare/mdwrk-vs-obsidian.md +27 -0
- package/content/pages/compare/mdwrk-vs-typora.md +27 -0
- package/content/pages/compare/mdwrk-vs-vscode-markdown.md +27 -0
- package/content/pages/docs/extensions.md +34 -0
- package/content/pages/docs/quickstart.md +48 -0
- package/content/pages/docs/theme-packs.md +34 -0
- package/content/pages/es/docs/quickstart.md +50 -0
- package/content/pages/features/extension-runtime.md +25 -0
- package/content/pages/features/github-sync.md +25 -0
- package/content/pages/features/index.md +42 -0
- package/content/pages/features/indexeddb-markdown-storage.md +25 -0
- package/content/pages/features/live-preview.md +25 -0
- package/content/pages/features/pwa-markdown-editor.md +25 -0
- package/content/pages/index.md +45 -0
- package/content/pages/markdown/basic-markdown-syntax.md +29 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/benefits.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/best-practices.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/checklist.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/examples.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/for-developers.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/for-teams.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/use-cases.md +31 -0
- package/content/pages/markdown/generated/local-first-markdown-workspace/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-blogging/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-documentation/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-editor/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-extension-workflows/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-for-developers/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-for-teams/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-knowledge-base/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-notes/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-preview/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-project-docs/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-readme/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-theme-packs/workflow.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/benefits.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/best-practices.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/checklist.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/examples.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/for-developers.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/for-teams.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/use-cases.md +31 -0
- package/content/pages/markdown/generated/markdown-writing-workflow/workflow.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/benefits.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/best-practices.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/checklist.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/examples.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/for-developers.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/for-teams.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/use-cases.md +31 -0
- package/content/pages/markdown/generated/offline-markdown-editor/workflow.md +31 -0
- package/content/pages/markdown/how-to-write-markdown.md +29 -0
- package/content/pages/markdown/index.md +40 -0
- package/content/pages/markdown/markdown-vs-html.md +29 -0
- package/content/pages/markdown/what-is-a-markdown-editor.md +29 -0
- package/content/pages/markdown/what-is-markdown-used-for.md +29 -0
- package/content/pages/markdown/what-is-markdown.md +29 -0
- package/content/pages/packages/extension-runtime.md +33 -0
- package/content/pages/packages/index.md +42 -0
- package/content/pages/packages/markdown-editor-react.md +33 -0
- package/content/pages/packages/markdown-renderer-core.md +33 -0
- package/content/pages/packages/markdown-renderer-react.md +33 -0
- package/content/pages/packages/theme-contract.md +33 -0
- package/content/pages/privacy.md +41 -0
- package/content/pages/proof/browser-support.md +22 -0
- package/content/pages/proof/markdown-support.md +22 -0
- package/content/pages/proof/package-surfaces.md +22 -0
- package/content/pages/security.md +38 -0
- package/content/pages/trust/privacy-boundary.md +22 -0
- package/data/article-metadata.schema.json +111 -0
- package/data/content-sitemap.yaml +31 -0
- package/data/content.ts +55 -0
- package/data/docs.ts +111 -0
- package/data/markdown/AGENTS.md +10 -0
- package/data/markdown/blog/client-split-out-backstory.md +97 -0
- package/data/markdown/blog/desktop-release-and-android-verification.md +65 -0
- package/data/markdown/blog/docs-surface-realignment.md +70 -0
- package/data/markdown/blog/extension-compatibility-and-publish-gates.md +59 -0
- package/data/markdown/blog/extension-host-rollout.md +92 -0
- package/data/markdown/blog/governed-releases-and-package-docs.md +69 -0
- package/data/markdown/blog/markdown-workspace-launch.md +75 -0
- package/data/markdown/blog/pwa-install-and-zoom-controls.md +64 -0
- package/data/markdown/blog/responsive-authoring-and-export.md +64 -0
- package/data/markdown/blog/retained-client-versions-and-desktop-shell.md +59 -0
- package/data/markdown/blog/screenshot-matrix-and-browser-sidebars.md +57 -0
- package/data/markdown/blog/settings-simplification-for-daily-flow.md +54 -0
- package/data/markdown/blog/workspace-files-and-git-ops-packages.md +53 -0
- package/data/markdown/docs/authoring/authoring-overview.md +59 -0
- package/data/markdown/docs/authoring/extension-authoring-guide.md +69 -0
- package/data/markdown/docs/authoring/extensions.md +93 -0
- package/data/markdown/docs/authoring/language-packs.md +81 -0
- package/data/markdown/docs/authoring/theme-packs.md +81 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-logseq.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-marktext.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-notion.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-obsidian.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-standard-markdown-editors.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-typora.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-vs-code.md +49 -0
- package/data/markdown/docs/comparisons/mdwrk-vs-zettlr.md +49 -0
- package/data/markdown/docs/extensions/extension-platform.md +64 -0
- package/data/markdown/docs/extensions/theme-studio-and-host-surfaces.md +54 -0
- package/data/markdown/docs/getting-started/browser-use.md +59 -0
- package/data/markdown/docs/getting-started/configuration.md +82 -0
- package/data/markdown/docs/getting-started/installation.md +74 -0
- package/data/markdown/docs/getting-started/local-setup.md +94 -0
- package/data/markdown/docs/getting-started/pwa-installation.md +62 -0
- package/data/markdown/docs/getting-started/standalone-modules.md +87 -0
- package/data/markdown/docs/github-sync.md +51 -0
- package/data/markdown/docs/product/desktop-app-boundary.md +57 -0
- package/data/markdown/docs/product/developer-documentation.md +52 -0
- package/data/markdown/docs/product/extension-host.md +52 -0
- package/data/markdown/docs/product/local-first-markdown-workspace.md +52 -0
- package/data/markdown/docs/product/markdown-file-manager.md +52 -0
- package/data/markdown/docs/product/markdown-preview-editor.md +52 -0
- package/data/markdown/docs/product/markdown-profile-architecture.md +51 -0
- package/data/markdown/docs/product/offline-markdown-editor.md +52 -0
- package/data/markdown/docs/product/privacy-first-markdown-editor.md +52 -0
- package/data/markdown/docs/product/theme-packs.md +52 -0
- package/data/markdown/docs/product/uix-responsive-contract.md +51 -0
- package/data/markdown/docs/usage/advanced-formatting.md +181 -0
- package/data/markdown/docs/usage/checkbox-autocomplete.md +51 -0
- package/data/markdown/docs/usage/editor-basics.md +138 -0
- package/data/markdown/docs/usage/rendering-and-preview.md +157 -0
- package/data/markdown/docs/usage/text-wrap-previewer.md +45 -0
- package/data/markdown/docs/usage/ui-refresh-1-3-28.md +43 -0
- package/data/markdown/docs/usage/ui-refresh-1-3-29.md +44 -0
- package/data/markdown/docs/usage/view-toolbar.md +47 -0
- package/data/markdown/legal/privacy.md +21 -0
- package/data/markdown/legal/terms.md +19 -0
- package/data/markdown-topic-matrix.json +169 -0
- package/dist/index.d.ts +26 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +49 -0
- package/dist/index.js.map +1 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +2 -0
- package/dist/version.js.map +1 -0
- package/generated/cache-header-manifest.json +6558 -0
- package/generated/content-index.json +3689 -0
- package/generated/content-registry.json +15203 -0
- package/generated/jsonld-graph.json +21815 -0
- package/generated/llms-full.txt +1769 -0
- package/generated/llms.txt +225 -0
- package/generated/robots.txt +28 -0
- package/generated/semantic-index.json +7595 -0
- package/generated/sitemap.xml +1114 -0
- package/generated/sitemap.xsl +59 -0
- package/package.json +57 -0
- package/public/blog/media/extension-manager-pane.jpg +0 -0
- package/public/blog/media/lander-blog-list.png +0 -0
- package/public/blog/media/lander-docs-dark.png +0 -0
- package/public/blog/media/lander-home-light.png +0 -0
- package/public/blog/media/language-pack-studio-pane.jpg +0 -0
- package/public/blog/media/mdwrk-git-pane.png +0 -0
- package/public/blog/media/mdwrk-settings-visual.png +0 -0
- package/public/blog/media/mdwrk-workspace-editor.png +0 -0
- package/public/blog/media/mdwrk-workspace-split.png +0 -0
- package/public/blog/media/settings-github-configurations.jpg +0 -0
- package/public/blog/media/theme-selector-modal.jpg +0 -0
- package/public/blog/media/theme-studio-pane.jpg +0 -0
- package/public/favicon.svg +10 -0
- package/public/llms.txt +85 -0
- package/public/og-image.png +0 -0
- package/public/og-image.svg +12 -0
- package/public/robots.txt +4 -0
- package/public/semantic-index.json +1627 -0
- package/public/sitemap.xml +342 -0
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Markdown File Manager
|
|
3
|
+
slug: product/markdown-file-manager
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 13
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk manages Markdown projects, files, folders, preview navigation, and workspace entries so documents stay organized inside the same surface where they are written.
|
|
13
|
+
relatedApis: @mdwrk/mdwrkspace, @mdwrk/extension-workspace-files
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## File Operations
|
|
17
|
+
|
|
18
|
+
The client supports project and entry workflows such as creating files, organizing folders, renaming entries, deleting obsolete content, and moving between documents without leaving the workspace shell.
|
|
19
|
+
|
|
20
|
+
## Preview Navigation
|
|
21
|
+
|
|
22
|
+
Internal Markdown links can navigate between files and headings. That makes the file manager useful for documentation sets, linked notes, release notes, and package READMEs.
|
|
23
|
+
|
|
24
|
+
## Desktop-Backed Workflows
|
|
25
|
+
|
|
26
|
+
Where the desktop shell is available, host file acquisition and filesystem-backed behavior can sit beside browser-managed workspaces. The client keeps those paths explicit.
|
|
27
|
+
|
|
28
|
+
## Related Docs
|
|
29
|
+
|
|
30
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
31
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
32
|
+
- [Local Setup](/docs/getting-started/local-setup)
|
|
33
|
+
|
|
34
|
+
## Quick Reference
|
|
35
|
+
|
|
36
|
+
Use this article to understand Markdown File Manager in the MdWrk Product surface. MdWrk manages Markdown projects, files, folders, preview navigation, and workspace entries so documents stay organized inside the same surface where they are written.
|
|
37
|
+
|
|
38
|
+
Key concepts covered here:
|
|
39
|
+
|
|
40
|
+
- local Markdown files
|
|
41
|
+
- live preview
|
|
42
|
+
- workspace organization
|
|
43
|
+
- extension host contracts
|
|
44
|
+
- developer package reuse
|
|
45
|
+
|
|
46
|
+
Useful follow-up pages:
|
|
47
|
+
|
|
48
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
49
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
50
|
+
- [Browser Use](/docs/getting-started/browser-use)
|
|
51
|
+
|
|
52
|
+
MdWrk includes file-management behavior as part of the writing workspace.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Markdown Preview Editor
|
|
3
|
+
slug: product/markdown-preview-editor
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 14
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk combines a Markdown source editor with live preview, profile-aware rendering, internal-link navigation, HTML export, and print-oriented output.
|
|
13
|
+
relatedApis: @mdwrk/markdown-editor-react, @mdwrk/markdown-renderer-react, @mdwrk/markdown-renderer-core
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Editor And Preview Modes
|
|
17
|
+
|
|
18
|
+
Use editor-only mode for drafting, split mode for validating output while writing, and preview-only mode for reading, review, and export inspection.
|
|
19
|
+
|
|
20
|
+
## Rendering Contract
|
|
21
|
+
|
|
22
|
+
The preview uses the same renderer family that powers reusable package surfaces. CommonMark, GFM, profile-aware optional syntax, advisory policy, and export behavior stay aligned.
|
|
23
|
+
|
|
24
|
+
## Output Paths
|
|
25
|
+
|
|
26
|
+
HTML export and print preview are connected to the preview pipeline so approved on-screen structure stays close to exported output.
|
|
27
|
+
|
|
28
|
+
## Related Docs
|
|
29
|
+
|
|
30
|
+
- [Editor Basics](/features/editor-basics)
|
|
31
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
32
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
33
|
+
|
|
34
|
+
## Quick Reference
|
|
35
|
+
|
|
36
|
+
Use this article to understand Markdown Preview Editor in the MdWrk Product surface. MdWrk combines a Markdown source editor with live preview, profile-aware rendering, internal-link navigation, HTML export, and print-oriented output.
|
|
37
|
+
|
|
38
|
+
Key concepts covered here:
|
|
39
|
+
|
|
40
|
+
- live preview
|
|
41
|
+
- developer package reuse
|
|
42
|
+
- @mdwrk/markdown-editor-react
|
|
43
|
+
- @mdwrk/markdown-renderer-react
|
|
44
|
+
- @mdwrk/markdown-renderer-core
|
|
45
|
+
|
|
46
|
+
Useful follow-up pages:
|
|
47
|
+
|
|
48
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
49
|
+
- [Editor Basics](/features/editor-basics)
|
|
50
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
51
|
+
|
|
52
|
+
MdWrk keeps source editing and rendered preview in the same workflow.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Markdown Profile Architecture
|
|
3
|
+
slug: product/markdown-profile-architecture
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 17
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-06
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: Markdown profile architecture describes how MdWrk separates CommonMark, GFM, custom profile options, renderer configuration, and evidence snapshots.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Profile Purpose
|
|
16
|
+
|
|
17
|
+
Markdown profiles let MdWrk describe which Markdown behaviors are active for editing, preview, export, and conformance evidence. The profile layer keeps rendering policy explicit instead of burying it inside ad hoc parser flags.
|
|
18
|
+
|
|
19
|
+
## Current Surfaces
|
|
20
|
+
|
|
21
|
+
The current profile implementation spans:
|
|
22
|
+
|
|
23
|
+
- renderer core profile definitions
|
|
24
|
+
- client profile settings
|
|
25
|
+
- editor and preview configuration
|
|
26
|
+
- generated conformance artifacts
|
|
27
|
+
- SSOT feature, claim, test, and evidence links
|
|
28
|
+
|
|
29
|
+
Client-facing profile configuration lives under `apps/client/src/features/markdownProfiles`. Renderer behavior lives under `packages/renderer/markdown-renderer-core`.
|
|
30
|
+
|
|
31
|
+
## Profile Responsibilities
|
|
32
|
+
|
|
33
|
+
A profile should declare:
|
|
34
|
+
|
|
35
|
+
- enabled Markdown extensions
|
|
36
|
+
- raw HTML policy
|
|
37
|
+
- task-list behavior
|
|
38
|
+
- underline and link policy
|
|
39
|
+
- heading anchor behavior
|
|
40
|
+
- renderer and preview expectations
|
|
41
|
+
- evidence lane used to prove the profile
|
|
42
|
+
|
|
43
|
+
## Evidence Lane
|
|
44
|
+
|
|
45
|
+
Profile evidence should point at executable tests, generated snapshots, and conformance reports. This keeps profile claims auditable across package changes, app settings changes, and release gates.
|
|
46
|
+
|
|
47
|
+
## Related Docs
|
|
48
|
+
|
|
49
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
50
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
51
|
+
- [Developer Documentation](/features/developer-documentation)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Offline Markdown Editor
|
|
3
|
+
slug: product/offline-markdown-editor
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 10
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk is an offline-capable Markdown editor that keeps writing, preview, workspace state, and installable app behavior available on the device after the client assets are loaded.
|
|
13
|
+
relatedApis: @mdwrk/mdwrkspace, @mdwrk/markdown-editor-react, @mdwrk/markdown-renderer-react
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Offline Editing Model
|
|
17
|
+
|
|
18
|
+
The workspace stores documents in browser-managed local storage and IndexedDB-backed client state. The PWA install path can keep the client available in a dedicated app window while the editor keeps source text and preview close together.
|
|
19
|
+
|
|
20
|
+
## Writing Workflow
|
|
21
|
+
|
|
22
|
+
Use the editor-only view for focused drafting, split view for live validation, and preview-only mode for review. Formatting commands write portable Markdown instead of proprietary document state.
|
|
23
|
+
|
|
24
|
+
## Local Storage Boundary
|
|
25
|
+
|
|
26
|
+
MdWrk does not require documents to be uploaded to a hosted service before editing. Sync and export are intentional workflows, not hidden defaults.
|
|
27
|
+
|
|
28
|
+
## Related Docs
|
|
29
|
+
|
|
30
|
+
- [Browser Use](/docs/getting-started/browser-use)
|
|
31
|
+
- [PWA Installation](/docs/getting-started/pwa-installation)
|
|
32
|
+
- [Editor Basics](/features/editor-basics)
|
|
33
|
+
|
|
34
|
+
## Quick Reference
|
|
35
|
+
|
|
36
|
+
Use this article to understand Offline Markdown Editor in the MdWrk Product surface. MdWrk is an offline-capable Markdown editor that keeps writing, preview, workspace state, and installable app behavior available on the device after the client assets are loaded.
|
|
37
|
+
|
|
38
|
+
Key concepts covered here:
|
|
39
|
+
|
|
40
|
+
- local Markdown files
|
|
41
|
+
- live preview
|
|
42
|
+
- workspace organization
|
|
43
|
+
- privacy-first storage
|
|
44
|
+
- extension host contracts
|
|
45
|
+
|
|
46
|
+
Useful follow-up pages:
|
|
47
|
+
|
|
48
|
+
- [Offline Markdown Editor](/features/offline-markdown-editor)
|
|
49
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
50
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
51
|
+
|
|
52
|
+
MdWrk gives Markdown authors a browser-first editor that continues to work when the network is unavailable.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Privacy-First Markdown Editor
|
|
3
|
+
slug: product/privacy-first-markdown-editor
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 12
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk is a privacy-first Markdown editor that keeps documents on the device by default and makes sync, export, extension trust, and external services explicit choices.
|
|
13
|
+
relatedApis: @mdwrk/mdwrkspace, @mdwrk/extension-host, @mdwrk/extension-manifest
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Privacy Boundary
|
|
17
|
+
|
|
18
|
+
The default workspace keeps document content in local browser storage. The product does not need to upload Markdown to MdWrk servers before you can write, preview, or manage files.
|
|
19
|
+
|
|
20
|
+
## Explicit Sharing
|
|
21
|
+
|
|
22
|
+
Export, GitHub sync, and extension-based workflows are intentional paths. They make the boundary visible so authors can decide when content leaves the local workspace.
|
|
23
|
+
|
|
24
|
+
## Extension Trust
|
|
25
|
+
|
|
26
|
+
Installable extensions use manifests, integrity metadata, compatibility rules, and trust policy inputs. That gives extension behavior a documented control surface instead of treating every package as automatically trusted.
|
|
27
|
+
|
|
28
|
+
## Related Docs
|
|
29
|
+
|
|
30
|
+
- [Extension Platform](/docs/extensions/extension-platform)
|
|
31
|
+
- [Client Configuration](/docs/getting-started/configuration)
|
|
32
|
+
- [Privacy Policy](/legal/privacy)
|
|
33
|
+
|
|
34
|
+
## Quick Reference
|
|
35
|
+
|
|
36
|
+
Use this article to understand Privacy-First Markdown Editor in the MdWrk Product surface. MdWrk is a privacy-first Markdown editor that keeps documents on the device by default and makes sync, export, extension trust, and external services explicit choices.
|
|
37
|
+
|
|
38
|
+
Key concepts covered here:
|
|
39
|
+
|
|
40
|
+
- local Markdown files
|
|
41
|
+
- live preview
|
|
42
|
+
- workspace organization
|
|
43
|
+
- privacy-first storage
|
|
44
|
+
- extension host contracts
|
|
45
|
+
|
|
46
|
+
Useful follow-up pages:
|
|
47
|
+
|
|
48
|
+
- [Privacy-First Markdown Editor](/features/privacy-first-markdown-editor)
|
|
49
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
50
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
51
|
+
|
|
52
|
+
MdWrk is designed so writing does not require a hosted document account.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Theme Packs
|
|
3
|
+
slug: product/theme-packs
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 16
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk theme packs use a shared token and class-name contract so editor, renderer, extension, and workspace surfaces can be styled without private app selectors.
|
|
13
|
+
relatedApis: @mdwrk/theme-contract, @mdwrk/extension-theme-studio, @mdwrk/ui-tokens
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Theme Contract
|
|
17
|
+
|
|
18
|
+
Theme packs target shared tokens, bridge variables, and class names. This keeps theme behavior portable across the editor, renderer, host, and extension views.
|
|
19
|
+
|
|
20
|
+
## Theme Studio
|
|
21
|
+
|
|
22
|
+
The Theme Studio extension provides a first-party authoring workflow for inspecting tokens, previewing editor and renderer changes, applying draft values, reverting them, and exporting theme artifacts.
|
|
23
|
+
|
|
24
|
+
## Viewport Contract
|
|
25
|
+
|
|
26
|
+
Viewport and aspect-ratio breakpoints stay defined once in the client viewport contract. Themes can style each band, but they do not redefine the responsive taxonomy.
|
|
27
|
+
|
|
28
|
+
## Related Docs
|
|
29
|
+
|
|
30
|
+
- [Theme Pack Authoring](/docs/authoring/theme-packs)
|
|
31
|
+
- [Theme Studio And Host Surfaces](/docs/extensions/theme-studio-and-host-surfaces)
|
|
32
|
+
- [Client Configuration](/docs/getting-started/configuration)
|
|
33
|
+
|
|
34
|
+
## Quick Reference
|
|
35
|
+
|
|
36
|
+
Use this article to understand Theme Packs in the MdWrk Product surface. MdWrk theme packs use a shared token and class-name contract so editor, renderer, extension, and workspace surfaces can be styled without private app selectors.
|
|
37
|
+
|
|
38
|
+
Key concepts covered here:
|
|
39
|
+
|
|
40
|
+
- live preview
|
|
41
|
+
- workspace organization
|
|
42
|
+
- extension host contracts
|
|
43
|
+
- theme portability
|
|
44
|
+
- @mdwrk/theme-contract
|
|
45
|
+
|
|
46
|
+
Useful follow-up pages:
|
|
47
|
+
|
|
48
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
49
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
50
|
+
- [Editor Basics](/features/editor-basics)
|
|
51
|
+
|
|
52
|
+
MdWrk treats themes as portable product surfaces.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UIX Responsive Contract
|
|
3
|
+
slug: product/uix-responsive-contract
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 18
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-06
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: The UIX responsive contract documents MdWrk viewport bands, aspect-ratio bands, height tiers, device classes, and theme responsibilities.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Contract Summary
|
|
16
|
+
|
|
17
|
+
MdWrk defines viewport and aspect-ratio bands once and lets themes style those bands without redefining the breakpoints. The contract keeps app structure predictable across phone, tablet, desktop, wide, and ultra-wide workspaces.
|
|
18
|
+
|
|
19
|
+
The active contract is implemented in `apps/client/styles/base/viewports.css`.
|
|
20
|
+
|
|
21
|
+
## Aspect Bands
|
|
22
|
+
|
|
23
|
+
The workspace classifies layout by aspect ratio:
|
|
24
|
+
|
|
25
|
+
- portrait
|
|
26
|
+
- square-hybrid
|
|
27
|
+
- landscape
|
|
28
|
+
- wide
|
|
29
|
+
- ultra-wide
|
|
30
|
+
|
|
31
|
+
These bands guide shell density, pane stacking, sidebar behavior, and safe-area spacing.
|
|
32
|
+
|
|
33
|
+
## Width And Height Tiers
|
|
34
|
+
|
|
35
|
+
Width tiers are `xs`, `sm`, `md`, `lg`, `xl`, and `xxl`. Height tiers are `short`, `compact`, `tall`, and `ultra-tall`.
|
|
36
|
+
|
|
37
|
+
Themes may respond to these tiers, but the tier names and cutoffs remain a base contract.
|
|
38
|
+
|
|
39
|
+
## Device Class
|
|
40
|
+
|
|
41
|
+
The contract distinguishes touch and precision devices. Touch layouts can enlarge hit targets and simplify pane density, while precision layouts can preserve denser controls for keyboard and pointer workflows.
|
|
42
|
+
|
|
43
|
+
## Theme Responsibility
|
|
44
|
+
|
|
45
|
+
Themes are responsible for unique styling per band. They should not copy breakpoint definitions into theme files. A theme can change color, spacing, surface treatment, and visual density while leaving the base viewport taxonomy intact.
|
|
46
|
+
|
|
47
|
+
## Related Docs
|
|
48
|
+
|
|
49
|
+
- [Editor Basics](/features/editor-basics)
|
|
50
|
+
- [Desktop App Boundary](/features/desktop-app-boundary)
|
|
51
|
+
- [Theme Packs](/features/theme-packs)
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Markdown Formatting
|
|
3
|
+
slug: usage/advanced-formatting
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 2
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk uses a CommonMark plus GFM baseline, exposes optional formatting profiles for footnotes, math, and related syntax, and adds opinionated editor tools for faster authoring without locking documents into a proprietary format.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Baseline Conformance
|
|
16
|
+
|
|
17
|
+
The repository default remains **CommonMark 0.31.2 + GFM 0.29-gfm**.
|
|
18
|
+
|
|
19
|
+
That means MdWrk treats standard Markdown as the primary portable surface for:
|
|
20
|
+
|
|
21
|
+
- headings
|
|
22
|
+
- paragraphs
|
|
23
|
+
- emphasis
|
|
24
|
+
- strong emphasis
|
|
25
|
+
- links
|
|
26
|
+
- images
|
|
27
|
+
- blockquotes
|
|
28
|
+
- thematic breaks
|
|
29
|
+
- inline code
|
|
30
|
+
- fenced code blocks
|
|
31
|
+
- ordered and unordered lists
|
|
32
|
+
- GitHub-style task lists
|
|
33
|
+
- GitHub-style tables
|
|
34
|
+
- strikethrough
|
|
35
|
+
|
|
36
|
+
```markdown
|
|
37
|
+
# Product Overview
|
|
38
|
+
|
|
39
|
+
MdWrk keeps drafting local by default.
|
|
40
|
+
|
|
41
|
+
> Preview and source stay aligned.
|
|
42
|
+
|
|
43
|
+
- local-first editing
|
|
44
|
+
- portable Markdown output
|
|
45
|
+
- optional sync later
|
|
46
|
+
|
|
47
|
+
| Surface | Status |
|
|
48
|
+
| :--- | :--- |
|
|
49
|
+
| Editor | Ready |
|
|
50
|
+
| Preview | Ready |
|
|
51
|
+
|
|
52
|
+
- [x] Draft
|
|
53
|
+
- [ ] Publish
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## What the Renderer Guarantees
|
|
57
|
+
|
|
58
|
+
The same renderer family powers the MdWrk preview surface and this lander, so the formatting contract is shared across documentation and the client.
|
|
59
|
+
|
|
60
|
+
- Front matter is parsed into metadata and omitted from rendered body output.
|
|
61
|
+
- Heading extraction is available for table-of-contents and navigation surfaces.
|
|
62
|
+
- GFM task list items render as semantic checkbox rows.
|
|
63
|
+
- GFM tables render as semantic table markup.
|
|
64
|
+
- Fenced code blocks render into portable code block containers with a header/surface structure.
|
|
65
|
+
- HTML export and full HTML document generation preserve the same Markdown render contract.
|
|
66
|
+
|
|
67
|
+
## Optional Markdown Profiles
|
|
68
|
+
|
|
69
|
+
MdWrk keeps the CommonMark plus GFM baseline on by default. Optional profiles can be enabled from the Markdown profile settings when a document needs more expressive syntax.
|
|
70
|
+
|
|
71
|
+
### In-Scope Profiles
|
|
72
|
+
|
|
73
|
+
- `front-matter`: YAML-style metadata blocks are parsed into document metadata and removed from rendered body content.
|
|
74
|
+
- `footnotes`: Footnote references and definitions render into linked footnote sections.
|
|
75
|
+
- `definition-lists`: Definition list syntax renders into `dl`, `dt`, and `dd` structures.
|
|
76
|
+
- `math`: Inline and block math are structurally recognized. This checkpoint does not typeset equations with KaTeX or MathJax.
|
|
77
|
+
- `superscript`: Caret-based superscript syntax is supported when the profile is enabled.
|
|
78
|
+
- `subscript`: Tilde-based subscript syntax is supported when the profile is enabled.
|
|
79
|
+
- `smart-punctuation`: Smart punctuation transforms are available when explicitly enabled.
|
|
80
|
+
|
|
81
|
+
### Experimental or Out-of-Boundary Profiles
|
|
82
|
+
|
|
83
|
+
- `citations`: Citation keys are recognized structurally, but bibliography resolution is still outside the certified formatting boundary.
|
|
84
|
+
- `markdown-in-html`: Markdown inside trusted HTML containers is available only when that profile is enabled and trusted HTML preview/export is also enabled.
|
|
85
|
+
|
|
86
|
+
## Trusted HTML Rule
|
|
87
|
+
|
|
88
|
+
Trusted HTML is off by default.
|
|
89
|
+
|
|
90
|
+
Use it only for content you trust. It exists so HTML-aware profiles such as `markdown-in-html` can pass through preview and export intentionally instead of silently broadening the parsing surface for every document.
|
|
91
|
+
|
|
92
|
+
## Opinionated MdWrk Authoring Extras
|
|
93
|
+
|
|
94
|
+
MdWrk adds editor conveniences on top of portable Markdown. These tools write Markdown for you, but the saved document remains plain text.
|
|
95
|
+
|
|
96
|
+
### Toolbar Actions
|
|
97
|
+
|
|
98
|
+
The editor toolbar currently exposes direct authoring controls for:
|
|
99
|
+
|
|
100
|
+
- bold
|
|
101
|
+
- italic
|
|
102
|
+
- strikethrough
|
|
103
|
+
- bullet lists
|
|
104
|
+
- task lists
|
|
105
|
+
- indent
|
|
106
|
+
- outdent
|
|
107
|
+
- inline math
|
|
108
|
+
- footnotes
|
|
109
|
+
- superscript
|
|
110
|
+
- subscript
|
|
111
|
+
- undo
|
|
112
|
+
- redo
|
|
113
|
+
- insert table
|
|
114
|
+
|
|
115
|
+
The toolbar also includes editor, split, and preview view controls so formatting and rendered output stay close together while you write.
|
|
116
|
+
|
|
117
|
+
### Keyboard and Editing Behavior
|
|
118
|
+
|
|
119
|
+
MdWrk includes opinionated editing behaviors that speed up list-heavy writing:
|
|
120
|
+
|
|
121
|
+
- `Ctrl/Cmd+B` wraps the current selection in `**bold**`
|
|
122
|
+
- `Ctrl/Cmd+I` wraps the current selection in `_italic_`
|
|
123
|
+
- `Ctrl/Cmd+Shift+X` wraps the current selection in `~~strikethrough~~`
|
|
124
|
+
- `Ctrl/Cmd+Z` and `Ctrl/Cmd+Shift+Z` drive undo and redo
|
|
125
|
+
- `Tab` indents the current line or selection
|
|
126
|
+
- `Shift+Tab` outdents the current line or selection
|
|
127
|
+
- `Enter` inside a list item continues the list automatically
|
|
128
|
+
- `Enter` on an empty bullet, ordered, or task-list item terminates that list item cleanly
|
|
129
|
+
|
|
130
|
+
### Table Builder
|
|
131
|
+
|
|
132
|
+
MdWrk includes an opinionated table insertion control in the editor toolbar. It helps generate table scaffolding quickly instead of requiring you to hand-type the initial pipe layout.
|
|
133
|
+
|
|
134
|
+
After insertion, the table remains ordinary Markdown:
|
|
135
|
+
|
|
136
|
+
```markdown
|
|
137
|
+
| Column A | Column B |
|
|
138
|
+
| :--- | :--- |
|
|
139
|
+
| Value | Value |
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Structured Inserts
|
|
143
|
+
|
|
144
|
+
Some current toolbar actions intentionally scaffold a known Markdown pattern instead of leaving the exact syntax to memory:
|
|
145
|
+
|
|
146
|
+
- footnote insertion adds a `[^1]` style reference marker
|
|
147
|
+
- inline math wraps the selection in `$...$`
|
|
148
|
+
- superscript wraps the selection in `^...^`
|
|
149
|
+
- subscript wraps the selection in `~...~`
|
|
150
|
+
|
|
151
|
+
These are authoring conveniences, not a separate file format.
|
|
152
|
+
|
|
153
|
+
## Practical Portability Guidance
|
|
154
|
+
|
|
155
|
+
Use the default CommonMark plus GFM surface when the same file needs to render well in MdWrk, GitHub, npm documentation, and other static Markdown tooling.
|
|
156
|
+
|
|
157
|
+
Enable optional profiles only when the document actually needs them. This keeps the source more portable and reduces surprises when the file moves into another renderer.
|
|
158
|
+
|
|
159
|
+
## Related Docs
|
|
160
|
+
|
|
161
|
+
- [Editor Basics](/features/editor-basics)
|
|
162
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
163
|
+
- [Client Configuration](/docs/getting-started/configuration)
|
|
164
|
+
|
|
165
|
+
## Quick Reference
|
|
166
|
+
|
|
167
|
+
Use this article to understand Markdown Formatting in the MdWrk Product surface. MdWrk uses a CommonMark plus GFM baseline, exposes optional formatting profiles for footnotes, math, and related syntax, and adds opinionated editor tools for faster authoring without locking documents into a proprietary format.
|
|
168
|
+
|
|
169
|
+
Key concepts covered here:
|
|
170
|
+
|
|
171
|
+
- local Markdown files
|
|
172
|
+
- live preview
|
|
173
|
+
- theme portability
|
|
174
|
+
|
|
175
|
+
Useful follow-up pages:
|
|
176
|
+
|
|
177
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
178
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
179
|
+
- [Editor Basics](/features/editor-basics)
|
|
180
|
+
|
|
181
|
+
Use this page when you want the exact Markdown formatting contract that MdWrk previews, exports, and edits today.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Checkbox Autocomplete
|
|
3
|
+
slug: usage/checkbox-autocomplete
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 6
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-06
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: Checkbox autocomplete documents how MdWrk turns list authoring into task-list Markdown while preserving plain-text portability.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## What Checkbox Autocomplete Is For
|
|
16
|
+
|
|
17
|
+
Checkbox autocomplete helps writers create task lists without memorizing every Markdown marker. MdWrk keeps the source document portable by writing normal task-list syntax such as `- [ ] Task` and `- [x] Done`.
|
|
18
|
+
|
|
19
|
+
Use this page when you want the current checklist behavior for notes, issue plans, release checklists, and documentation tasks.
|
|
20
|
+
|
|
21
|
+
## Supported Markdown Shape
|
|
22
|
+
|
|
23
|
+
MdWrk treats these forms as task-list rows:
|
|
24
|
+
|
|
25
|
+
```markdown
|
|
26
|
+
- [ ] Draft the doc
|
|
27
|
+
- [x] Review the change
|
|
28
|
+
1. [ ] Verify the build
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The editor command layer can convert a plain line, bullet line, or ordered-list line into a task-list item. The renderer then displays the checkbox state while keeping the original Markdown available for export, Git, and copy/paste.
|
|
32
|
+
|
|
33
|
+
## Authoring Flow
|
|
34
|
+
|
|
35
|
+
1. Put the cursor on a line or select multiple lines.
|
|
36
|
+
2. Use the task-list toolbar action.
|
|
37
|
+
3. Continue writing the task text.
|
|
38
|
+
4. Press `Enter` to continue the checklist.
|
|
39
|
+
5. Press `Enter` on an empty checklist row to leave the list.
|
|
40
|
+
|
|
41
|
+
The behavior is implemented in the editor command and list-continuation pipeline, so toolbar and keyboard entry stay aligned.
|
|
42
|
+
|
|
43
|
+
## Focus Behavior
|
|
44
|
+
|
|
45
|
+
Checkbox rows remain part of the source editor document. Toggling or continuing a checklist should keep the writing flow in the editor instead of forcing the user to recover focus from the preview.
|
|
46
|
+
|
|
47
|
+
## Related Docs
|
|
48
|
+
|
|
49
|
+
- [Editor Basics](/features/editor-basics)
|
|
50
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
51
|
+
- [View Toolbar](/features/view-toolbar/)
|