@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,138 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Editor Basics
|
|
3
|
+
slug: usage/editor-basics
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 1
|
|
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, split preview workflow, table builder, formatting toolbar, and local-first workspace model so drafting stays fast without hiding the underlying Markdown.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## What the Editor Is For
|
|
16
|
+
|
|
17
|
+
MdWrk is built for direct Markdown authoring with immediate visual feedback. The editor stays plain-text first, but it removes a lot of the friction that usually makes Markdown feel slower than rich-text tools.
|
|
18
|
+
|
|
19
|
+
The client combines `@mdwrk/markdown-editor-react` for source editing and `@mdwrk/markdown-renderer-react` for preview, so writing and reading stay in the same workspace flow.
|
|
20
|
+
|
|
21
|
+
## Core Writing Views
|
|
22
|
+
|
|
23
|
+
MdWrk supports three primary work modes:
|
|
24
|
+
|
|
25
|
+
- editor-only for focused drafting
|
|
26
|
+
- split view for writing while checking rendered output
|
|
27
|
+
- preview-only for review, presentation, and export inspection
|
|
28
|
+
|
|
29
|
+
Split view includes a draggable divider and keyboard-adjustable separator so the balance between source and preview can be changed without leaving the work surface.
|
|
30
|
+
|
|
31
|
+
## Source Editing Features
|
|
32
|
+
|
|
33
|
+
The editor surface currently provides:
|
|
34
|
+
|
|
35
|
+
- controlled and uncontrolled document modes
|
|
36
|
+
- live cursor and selection tracking
|
|
37
|
+
- line-number gutter support
|
|
38
|
+
- undo and redo history
|
|
39
|
+
- keyboard shortcut support
|
|
40
|
+
- toolbar command execution
|
|
41
|
+
- selection-aware formatting state for bold, italic, strikethrough, bullet lists, and task lists
|
|
42
|
+
|
|
43
|
+
The result is a Markdown editor that still behaves like a real text editor instead of a fragile overlay on top of rich text.
|
|
44
|
+
|
|
45
|
+
## Formatting Toolbar
|
|
46
|
+
|
|
47
|
+
The default work-pane toolbar exposes direct authoring controls for:
|
|
48
|
+
|
|
49
|
+
- bold
|
|
50
|
+
- italic
|
|
51
|
+
- strikethrough
|
|
52
|
+
- bullet lists
|
|
53
|
+
- task lists
|
|
54
|
+
- indent
|
|
55
|
+
- outdent
|
|
56
|
+
- inline math
|
|
57
|
+
- footnotes
|
|
58
|
+
- superscript
|
|
59
|
+
- subscript
|
|
60
|
+
- undo
|
|
61
|
+
- redo
|
|
62
|
+
- insert table
|
|
63
|
+
|
|
64
|
+
MdWrk writes Markdown for these actions instead of storing proprietary formatting state.
|
|
65
|
+
|
|
66
|
+
## Keyboard Behavior
|
|
67
|
+
|
|
68
|
+
The editor adds a few opinionated behaviors that improve drafting speed:
|
|
69
|
+
|
|
70
|
+
- `Ctrl/Cmd+B` applies bold markers
|
|
71
|
+
- `Ctrl/Cmd+I` applies italic markers
|
|
72
|
+
- `Ctrl/Cmd+Shift+X` applies strikethrough markers
|
|
73
|
+
- `Ctrl/Cmd+Z` and `Ctrl/Cmd+Shift+Z` drive undo and redo
|
|
74
|
+
- `Tab` indents the current line or selected block
|
|
75
|
+
- `Shift+Tab` outdents the current line or selected block
|
|
76
|
+
- `Enter` continues unordered, ordered, and task lists
|
|
77
|
+
- `Enter` on an empty list item exits the list cleanly
|
|
78
|
+
|
|
79
|
+
These behaviors are especially useful for notes, checklists, changelogs, and long structured documents.
|
|
80
|
+
|
|
81
|
+
## Table Builder
|
|
82
|
+
|
|
83
|
+
MdWrk includes a table builder in the work-pane toolbar. Instead of hand-building the first pipe grid, you can choose row and column counts and insert a ready-to-edit Markdown table.
|
|
84
|
+
|
|
85
|
+
```markdown
|
|
86
|
+
| Column 1 | Column 2 | Column 3 |
|
|
87
|
+
| --- | --- | --- |
|
|
88
|
+
| R1C1 | R1C2 | R1C3 |
|
|
89
|
+
| R2C1 | R2C2 | R2C3 |
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
After insertion, the table remains ordinary Markdown and can be edited anywhere.
|
|
93
|
+
|
|
94
|
+
## Workspace Model
|
|
95
|
+
|
|
96
|
+
Documents live in browser-managed local storage unless you intentionally connect another surface such as GitHub sync or export. This keeps drafting private by default and lets the editor continue working when network access is unavailable.
|
|
97
|
+
|
|
98
|
+
Common workspace operations include:
|
|
99
|
+
|
|
100
|
+
- creating files and folders
|
|
101
|
+
- renaming entries
|
|
102
|
+
- deleting obsolete content
|
|
103
|
+
- switching between projects
|
|
104
|
+
- keeping multiple Markdown documents available for internal linking and navigation
|
|
105
|
+
|
|
106
|
+
## Theme and Layout Behavior
|
|
107
|
+
|
|
108
|
+
The editor follows the shared viewport and aspect-ratio contract used across the workspace. Themes can style each breakpoint band differently, but the editing and preview layout rules stay predictable across portrait, square, landscape, wide, and ultra-wide usage.
|
|
109
|
+
|
|
110
|
+
## Why This Matters
|
|
111
|
+
|
|
112
|
+
MdWrk is not trying to hide Markdown behind a fake document model. The product goal is to make Markdown fast enough for daily writing while keeping the file portable, inspectable, and easy to move into GitHub, static documentation, package READMEs, or other publishing surfaces.
|
|
113
|
+
|
|
114
|
+
## Related Docs
|
|
115
|
+
|
|
116
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
117
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
118
|
+
- [Client Configuration](/docs/getting-started/configuration)
|
|
119
|
+
|
|
120
|
+
## Quick Reference
|
|
121
|
+
|
|
122
|
+
Use this article to understand Editor Basics in the MdWrk Product surface. MdWrk combines a markdown source editor, split preview workflow, table builder, formatting toolbar, and local-first workspace model so drafting stays fast without hiding the underlying Markdown.
|
|
123
|
+
|
|
124
|
+
Key concepts covered here:
|
|
125
|
+
|
|
126
|
+
- local Markdown files
|
|
127
|
+
- live preview
|
|
128
|
+
- workspace organization
|
|
129
|
+
- privacy-first storage
|
|
130
|
+
- theme portability
|
|
131
|
+
|
|
132
|
+
Useful follow-up pages:
|
|
133
|
+
|
|
134
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
135
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
136
|
+
- [Editor Basics](/features/editor-basics)
|
|
137
|
+
|
|
138
|
+
Use this page when you want the current MdWrk editor surface, not just the package names behind it.
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Rendering and Preview
|
|
3
|
+
slug: usage/rendering-and-preview
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 3
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-03
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: MdWrk turns Markdown into a live rendered preview with internal-link navigation, profile-aware HTML handling, policy advisories, and export paths that stay aligned with the on-screen renderer.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Live Preview Surface
|
|
16
|
+
|
|
17
|
+
MdWrk renders Markdown live inside the workspace so you can validate structure, spacing, tables, code blocks, task lists, and links while you write.
|
|
18
|
+
|
|
19
|
+
The preview surface is available in:
|
|
20
|
+
|
|
21
|
+
- split view beside the editor
|
|
22
|
+
- preview-only mode for reading and review
|
|
23
|
+
- export and print-oriented output flows
|
|
24
|
+
- lander documentation pages that reuse the same renderer family
|
|
25
|
+
|
|
26
|
+
## Shared Renderer Contract
|
|
27
|
+
|
|
28
|
+
MdWrk uses `@mdwrk/markdown-renderer-react` on top of `@mdwrk/markdown-renderer-core`. The renderer converts Markdown into semantic HTML and keeps the same baseline formatting contract across product surfaces.
|
|
29
|
+
|
|
30
|
+
That shared contract includes:
|
|
31
|
+
|
|
32
|
+
- headings and heading extraction
|
|
33
|
+
- paragraphs and inline emphasis
|
|
34
|
+
- links and images
|
|
35
|
+
- blockquotes
|
|
36
|
+
- ordered, unordered, and task lists
|
|
37
|
+
- tables
|
|
38
|
+
- fenced code blocks
|
|
39
|
+
- optional profile features such as footnotes, math, superscript, and subscript when enabled
|
|
40
|
+
|
|
41
|
+
## Internal Markdown Navigation
|
|
42
|
+
|
|
43
|
+
The workspace preview is not a dead render.
|
|
44
|
+
|
|
45
|
+
Internal Markdown links can resolve against the current workspace file set. That means preview links can:
|
|
46
|
+
|
|
47
|
+
- jump to a heading in the current document
|
|
48
|
+
- navigate to another Markdown file in the same workspace
|
|
49
|
+
- carry a pending hash so the destination preview scrolls to the intended section
|
|
50
|
+
|
|
51
|
+
This makes larger doc sets and linked note collections much easier to review without leaving the preview surface.
|
|
52
|
+
|
|
53
|
+
## Preview Policy and HTML Handling
|
|
54
|
+
|
|
55
|
+
Preview behavior is profile-aware.
|
|
56
|
+
|
|
57
|
+
MdWrk resolves HTML handling separately for preview and export so the product can show a clear policy instead of silently widening the trust boundary.
|
|
58
|
+
|
|
59
|
+
The current HTML handling modes are:
|
|
60
|
+
|
|
61
|
+
- `escape`
|
|
62
|
+
- `sanitize`
|
|
63
|
+
- `allow-trusted`
|
|
64
|
+
|
|
65
|
+
When preview policy warnings are relevant, the preview surface can show an advisory panel that summarizes the current HTML handling mode and any active profile warnings.
|
|
66
|
+
|
|
67
|
+
## Optional Profiles in Preview
|
|
68
|
+
|
|
69
|
+
The renderer respects the workspace Markdown profile configuration. That means the preview surface can reflect:
|
|
70
|
+
|
|
71
|
+
- footnotes
|
|
72
|
+
- definition lists
|
|
73
|
+
- math structures
|
|
74
|
+
- superscript
|
|
75
|
+
- subscript
|
|
76
|
+
- smart punctuation
|
|
77
|
+
- experimental profiles such as citations or markdown-in-html when explicitly enabled
|
|
78
|
+
|
|
79
|
+
This keeps preview behavior aligned with the configured document contract instead of guessing.
|
|
80
|
+
|
|
81
|
+
## Preview Actions
|
|
82
|
+
|
|
83
|
+
The workspace preview can expose direct output actions without leaving the rendered surface:
|
|
84
|
+
|
|
85
|
+
- HTML export
|
|
86
|
+
- print preview
|
|
87
|
+
|
|
88
|
+
These actions are available as overlay controls on the preview pane when the surrounding shell wires them in.
|
|
89
|
+
|
|
90
|
+
## HTML Export Alignment
|
|
91
|
+
|
|
92
|
+
MdWrk's HTML export is generated from the same rendering pipeline used for preview. That matters because the exported document is meant to look and behave like the preview you already approved.
|
|
93
|
+
|
|
94
|
+
The export flow currently includes:
|
|
95
|
+
|
|
96
|
+
- the active Markdown profile configuration
|
|
97
|
+
- profile-aware HTML handling
|
|
98
|
+
- advisory messaging when preview/export policy matters
|
|
99
|
+
- theme-aware styling
|
|
100
|
+
- configurable background mode
|
|
101
|
+
- print-oriented page styling
|
|
102
|
+
|
|
103
|
+
This keeps export from becoming a separate undocumented renderer with different results.
|
|
104
|
+
|
|
105
|
+
## Print and PDF-Oriented Output
|
|
106
|
+
|
|
107
|
+
MdWrk's export styles include print-specific controls for page shape and long-form document behavior.
|
|
108
|
+
|
|
109
|
+
Current output rules include:
|
|
110
|
+
|
|
111
|
+
- A4 portrait or landscape orientation
|
|
112
|
+
- explicit page margins
|
|
113
|
+
- print font size and line-height tokens
|
|
114
|
+
- heading keep-with-next behavior
|
|
115
|
+
- page-break helper hooks for Markdown-rendered content
|
|
116
|
+
|
|
117
|
+
These controls make the rendered output more useful for documentation reviews, handoffs, and printable deliverables.
|
|
118
|
+
|
|
119
|
+
## Theme-Aware Rendering
|
|
120
|
+
|
|
121
|
+
Preview and export styling are theme-aware. MdWrk bridges shared tokens into the renderer so Markdown surfaces inherit the active workspace language instead of feeling visually detached from the rest of the product.
|
|
122
|
+
|
|
123
|
+
That includes:
|
|
124
|
+
|
|
125
|
+
- foreground and muted text colors
|
|
126
|
+
- code block colors
|
|
127
|
+
- table header and row styling
|
|
128
|
+
- blockquote treatment
|
|
129
|
+
- print/export background choices
|
|
130
|
+
|
|
131
|
+
## Why This Matters
|
|
132
|
+
|
|
133
|
+
MdWrk treats rendering as a first-class product surface, not as a best-effort convenience after editing. The preview is where document structure, links, and export readiness become visible, so it needs to stay trustworthy and aligned with the actual file.
|
|
134
|
+
|
|
135
|
+
## Related Docs
|
|
136
|
+
|
|
137
|
+
- [Editor Basics](/features/editor-basics)
|
|
138
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
139
|
+
- [Client Configuration](/docs/getting-started/configuration)
|
|
140
|
+
|
|
141
|
+
## Quick Reference
|
|
142
|
+
|
|
143
|
+
Use this article to understand Rendering and Preview in the MdWrk Product surface. MdWrk turns Markdown into a live rendered preview with internal-link navigation, profile-aware HTML handling, policy advisories, and export paths that stay aligned with the on-screen renderer.
|
|
144
|
+
|
|
145
|
+
Key concepts covered here:
|
|
146
|
+
|
|
147
|
+
- live preview
|
|
148
|
+
- workspace organization
|
|
149
|
+
- theme portability
|
|
150
|
+
|
|
151
|
+
Useful follow-up pages:
|
|
152
|
+
|
|
153
|
+
- [Local-First Markdown Workspace](/features/local-first-markdown-workspace)
|
|
154
|
+
- [Markdown Preview Editor](/features/markdown-preview-editor)
|
|
155
|
+
- [Editor Basics](/features/editor-basics)
|
|
156
|
+
|
|
157
|
+
Use this page when you want the current MdWrk rendering contract across preview, navigation, HTML export, and print-oriented output.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Text Wrap Previewer
|
|
3
|
+
slug: usage/text-wrap-previewer
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 7
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-06
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: Text wrap previewer documents how MdWrk keeps source wrapping, preview wrapping, and line-number rhythm readable across pane sizes.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## What Text Wrap Previewer Covers
|
|
16
|
+
|
|
17
|
+
The text wrap previewer is the user-facing contract for readable long-form Markdown. It covers how source text wraps in the editor, how rendered Markdown wraps in preview, and how line numbers stay aligned when long source lines occupy multiple visual rows.
|
|
18
|
+
|
|
19
|
+
## Source Editor Wrapping
|
|
20
|
+
|
|
21
|
+
The source editor uses soft wrapping so files remain portable and line endings are not rewritten just to fit the pane. The editor estimates visual rows from the active text width and keeps the line-number gutter aligned with wrapped rows.
|
|
22
|
+
|
|
23
|
+
## Preview Wrapping
|
|
24
|
+
|
|
25
|
+
The preview pane uses the shared Markdown typography styles from the UI token layer. Paragraphs, code-adjacent prose, tables, and task lists should remain readable without forcing horizontal page scroll for normal prose.
|
|
26
|
+
|
|
27
|
+
## Split View Behavior
|
|
28
|
+
|
|
29
|
+
In split view, source and preview wrapping respond to the available pane width. The divider can change the wrapping context without changing the saved Markdown content.
|
|
30
|
+
|
|
31
|
+
## Practical Use
|
|
32
|
+
|
|
33
|
+
Use text wrap previewing when writing:
|
|
34
|
+
|
|
35
|
+
- long documentation pages
|
|
36
|
+
- checklist-heavy release notes
|
|
37
|
+
- narrow portrait-mode drafts
|
|
38
|
+
- split-pane review notes
|
|
39
|
+
- Markdown intended for static publishing
|
|
40
|
+
|
|
41
|
+
## Related Docs
|
|
42
|
+
|
|
43
|
+
- [Editor Basics](/features/editor-basics)
|
|
44
|
+
- [Rendering And Preview](/features/rendering-and-preview)
|
|
45
|
+
- [UIX Responsive Contract](/features/uix-responsive-contract/)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UI Refresh 1.3.28
|
|
3
|
+
slug: archive/ui-refresh-1-3-28
|
|
4
|
+
section: Archive
|
|
5
|
+
sectionOrder: 6
|
|
6
|
+
order: 25
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-02
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
excerpt: MdWrk 1.3.28 improves editing ergonomics, toolbar grouping, markdown list rendering, status footer behavior, and workspace action placement.
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Client update: `mdwrk/mdwrkspace` 1.3.28
|
|
15
|
+
|
|
16
|
+
This release improves editing ergonomics and cleans up key UI surfaces:
|
|
17
|
+
|
|
18
|
+
- Improved view-toolbar formatting grouping with a dedicated strikethrough convenience control.
|
|
19
|
+
- Nested markdown list marker rendering now shows only the deepest visible marker.
|
|
20
|
+
- Project selector cleanup and stronger border treatment for project/theme controls.
|
|
21
|
+
- Project delete confirmation modal upgraded for readability and action clarity.
|
|
22
|
+
- System Configuration modal sizing and spacing refined.
|
|
23
|
+
- System Configuration tab/pane labeling de-duplicated.
|
|
24
|
+
- Key mapping cards updated so command purpose + key binding remain legible at narrow widths.
|
|
25
|
+
|
|
26
|
+
## Notes
|
|
27
|
+
|
|
28
|
+
The viewport contract remains centralized in `apps/client/styles/base/viewports.css`; themes continue to style each breakpoint band independently.
|
|
29
|
+
|
|
30
|
+
## Quick Reference
|
|
31
|
+
|
|
32
|
+
Use this article to understand UI Refresh 1.3.28 in the MdWrk Archive surface. UI Refresh 1.3.28 explains how this MdWrk surface works in the current client and package system.
|
|
33
|
+
|
|
34
|
+
Key concepts covered here:
|
|
35
|
+
|
|
36
|
+
- theme portability
|
|
37
|
+
- developer package reuse
|
|
38
|
+
|
|
39
|
+
Useful follow-up pages:
|
|
40
|
+
|
|
41
|
+
- [Theme Packs](/features/theme-packs)
|
|
42
|
+
- [Advanced Markdown Formatting](/features/advanced-formatting)
|
|
43
|
+
- [Client Installation](/docs/getting-started/installation)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UI Refresh 1.3.29
|
|
3
|
+
slug: archive/ui-refresh-1-3-29
|
|
4
|
+
section: Archive
|
|
5
|
+
sectionOrder: 6
|
|
6
|
+
order: 26
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-02
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
excerpt: This release focuses on visual clarity, modal usability, and responsive behavior improvements-
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Client update: `mdwrk/mdwrkspace` 1.3.29
|
|
15
|
+
|
|
16
|
+
This release focuses on visual clarity, modal usability, and responsive behavior improvements:
|
|
17
|
+
|
|
18
|
+
- Added a dedicated strikethrough convenience button in the view toolbar controls.
|
|
19
|
+
- Fixed nested list marker rendering so only the deepest list item marker is shown.
|
|
20
|
+
- Project selector border treatments were tightened for clearer control boundaries.
|
|
21
|
+
- Theme selector now surfaces the project title context while preserving theme iconography.
|
|
22
|
+
- Project delete confirmation modal readability and hierarchy were enhanced.
|
|
23
|
+
- System Configuration modal dimensions were increased for better fit on large and medium screens.
|
|
24
|
+
- Reduced redundant system tab labeling and improved overall tab readability.
|
|
25
|
+
- Key mapping cards were updated to prevent text overlap between command labels and key bindings.
|
|
26
|
+
|
|
27
|
+
## Notes
|
|
28
|
+
|
|
29
|
+
Viewport and aspect-ratio breakpoints remain centralized in `apps/client/styles/base/viewports.css`.
|
|
30
|
+
|
|
31
|
+
## Quick Reference
|
|
32
|
+
|
|
33
|
+
Use this article to understand UI Refresh 1.3.29 in the MdWrk Archive surface. UI Refresh 1.3.29 explains how this MdWrk surface works in the current client and package system.
|
|
34
|
+
|
|
35
|
+
Key concepts covered here:
|
|
36
|
+
|
|
37
|
+
- theme portability
|
|
38
|
+
- developer package reuse
|
|
39
|
+
|
|
40
|
+
Useful follow-up pages:
|
|
41
|
+
|
|
42
|
+
- [Theme Packs](/features/theme-packs)
|
|
43
|
+
- [Client Installation](/docs/getting-started/installation)
|
|
44
|
+
- [Editor Basics](/features/editor-basics)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: View Toolbar
|
|
3
|
+
slug: usage/view-toolbar
|
|
4
|
+
section: Features
|
|
5
|
+
sectionOrder: 2
|
|
6
|
+
order: 8
|
|
7
|
+
toc: true
|
|
8
|
+
date: 2026-05-06
|
|
9
|
+
status: published
|
|
10
|
+
author: CobyCloud
|
|
11
|
+
displayAuthor: false
|
|
12
|
+
excerpt: View toolbar documents the MdWrk controls for switching editor, split, and preview modes while keeping export and formatting actions discoverable.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Toolbar Purpose
|
|
16
|
+
|
|
17
|
+
The view toolbar gives writers direct control over the active document surface. It keeps source editing, split preview, preview-only review, formatting commands, export actions, and table insertion close to the document.
|
|
18
|
+
|
|
19
|
+
## View Modes
|
|
20
|
+
|
|
21
|
+
MdWrk supports three primary document modes:
|
|
22
|
+
|
|
23
|
+
- editor
|
|
24
|
+
- split
|
|
25
|
+
- preview
|
|
26
|
+
|
|
27
|
+
Switching modes changes the visible panes without changing the Markdown document.
|
|
28
|
+
|
|
29
|
+
## Authoring Actions
|
|
30
|
+
|
|
31
|
+
The toolbar exposes common Markdown commands for formatting and document structure. These actions write Markdown syntax through the editor command model, which keeps the file portable.
|
|
32
|
+
|
|
33
|
+
Common commands include bold, italic, strikethrough, bullet list, task list, indent, outdent, inline math, footnote, superscript, subscript, undo, redo, and table insertion.
|
|
34
|
+
|
|
35
|
+
## Export Actions
|
|
36
|
+
|
|
37
|
+
The toolbar also provides Markdown export, HTML export, and print preview entry points. Export behavior uses the active document and current preview policy rather than a separate document model.
|
|
38
|
+
|
|
39
|
+
## Responsive Behavior
|
|
40
|
+
|
|
41
|
+
The toolbar must remain usable in narrow and portrait contexts. Controls can scroll or condense, but they should not cover the editor, preview, or modal content.
|
|
42
|
+
|
|
43
|
+
## Related Docs
|
|
44
|
+
|
|
45
|
+
- [Editor Basics](/features/editor-basics)
|
|
46
|
+
- [Text Wrap Previewer](/features/text-wrap-previewer/)
|
|
47
|
+
- [UIX Responsive Contract](/features/uix-responsive-contract/)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Privacy Policy
|
|
3
|
+
date: 2026-05-02
|
|
4
|
+
status: published
|
|
5
|
+
author: CobyCloud
|
|
6
|
+
lastUpdated: 2024-05-20
|
|
7
|
+
---
|
|
8
|
+
# Privacy Policy
|
|
9
|
+
|
|
10
|
+
At **MdWrk**, we believe privacy is a fundamental human right. Our software is designed so that your data never touches our servers.
|
|
11
|
+
|
|
12
|
+
## 1. Data Collection
|
|
13
|
+
We do not collect, store, or process any of your personal data. All markdown files created in the application are stored locally in your browser's IndexedDB.
|
|
14
|
+
|
|
15
|
+
## 2. Encryption
|
|
16
|
+
While data is local, we support client-side encryption for sensitive documents.
|
|
17
|
+
- **Algorithm**: AES-256-GCM
|
|
18
|
+
- **Key Storage**: Never stored, derived from your password.
|
|
19
|
+
|
|
20
|
+
## 3. GitHub Integration
|
|
21
|
+
If you choose to sync with GitHub, the application uses your Personal Access Token (PAT) to communicate directly with the GitHub API. This token is stored locally and never sent to our servers.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Terms of Service
|
|
3
|
+
date: 2026-05-02
|
|
4
|
+
status: published
|
|
5
|
+
author: CobyCloud
|
|
6
|
+
lastUpdated: 2024-05-20
|
|
7
|
+
---
|
|
8
|
+
# Terms of Service
|
|
9
|
+
|
|
10
|
+
Welcome to MdWrk. By using this application, you agree to the following:
|
|
11
|
+
|
|
12
|
+
## 1. "As-Is" Software
|
|
13
|
+
MdWrk is provided "as is" without any warranties.
|
|
14
|
+
|
|
15
|
+
## 2. Ownership
|
|
16
|
+
You own 100% of the content you create.
|
|
17
|
+
|
|
18
|
+
## 3. Compliance
|
|
19
|
+
MdWrk is intended for lawful use only. Users are responsible for their own data backups.
|