{{ message }}
Repository navigation
docs(end-user): align user docs with 0.19 prefs and platform matrix - #4300
Merged
Merged
Conversation
- PREFERENCES.md: full rewrite against src/main/preferences/schema.json. Adds the keys that landed since the table was last touched (fileSortOrder, openedFilesInSidebar, wrapCodeBlocks, editorLineWidth, codeBlockLineNumbers, autoNormalizeLineEndings, isHtmlEnabled, isGitlabCompatibilityEnabled, followSystemTheme/lightModeTheme/ darkModeTheme, restoreLayoutState, customCss, spellchecker* trio, imageInsertAction + image* relative-directory trio). Fixes a few stale defaults/enums (startUpAction default is `restoreAll`, fileSortBy default is `modified`, `imageDropAction` was renamed to `imageInsertAction`). - IMAGE_UPLOADER_CONFIGRATION.md: strip the GitHub uploader section — it was removed in #4276; PicGo is now the only built-in uploader. - CLI.md: document the `--disable-spellcheck` flag. - FAQ.md: refresh the supported-platforms list (macOS 11+, Windows 10/11, both x64 and arm64 for mac and Windows after #4279) and fix a broken developer-docs link. - THEMES.md: explain that the labels in the Theme menu map to different ids in `preferences.json` (Cadmium Light → `light`, etc.), and fix the `materal-dark.png` typo in the screenshot table. - ENVIRONMENT.md: drop the no-longer-used `MARKTEXT_DEV_HIDE_BROWSER_ANALYZER` row (removed during the electron-vite migration). - BASICS.md: note that the file tree now hosts a collapsible Opened Files subsection toggled via `openedFilesInSidebar` (#4278). - docs/README.md: add a link to IMAGES.md (it existed but wasn't surfaced from the end-user index). - README.md: refresh the platform badge and the macOS / Windows install sections so they describe the actual installer file names (`marktext-mac-(x64|arm64)-%version%.dmg`, `marktext-win-(x64|arm64)-%version%-setup.exe`) and reflect the Windows arm64 build added in #4279. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only refresh that brings the end-user docs and top-level README in sync with what MarkText 0.19 actually ships: new/changed preference keys and defaults, removal of the GitHub uploader, addition of the --disable-spellcheck CLI flag, updated supported-platform list, theme label↔id clarification, sidebar Opened Files note, and updated install instructions reflecting the new Windows arm64 build (#4279).
Changes:
- Full rewrite of
PREFERENCES.mdagainstsrc/main/preferences/schema.json(new keys, corrected defaults likestartUpAction=restoreAll,fileSortBy=modified, renameimageDropAction→imageInsertAction, plus Spelling/Image/Custom CSS sections). - Refresh of
IMAGE_UPLOADER_CONFIGRATION.md,FAQ.md,ENVIRONMENT.md,CLI.md,THEMES.md,BASICS.md,docs/README.mdto reflect removed/added features. - README install sections updated for macOS 11+ arm64/x64 and Windows 10/11 arm64/x64 installer file names.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Build artifacts for PR #4300: Run: https://github.com/marktext/marktext/actions/runs/26585672661 |
thimbleberrysystems
pushed a commit
to thimbleberrysystems/WordBird
that referenced
this pull request
Jun 21, 2026
…arktext#4300) - PREFERENCES.md: full rewrite against src/main/preferences/schema.json. Adds the keys that landed since the table was last touched (fileSortOrder, openedFilesInSidebar, wrapCodeBlocks, editorLineWidth, codeBlockLineNumbers, autoNormalizeLineEndings, isHtmlEnabled, isGitlabCompatibilityEnabled, followSystemTheme/lightModeTheme/ darkModeTheme, restoreLayoutState, customCss, spellchecker* trio, imageInsertAction + image* relative-directory trio). Fixes a few stale defaults/enums (startUpAction default is `restoreAll`, fileSortBy default is `modified`, `imageDropAction` was renamed to `imageInsertAction`). - IMAGE_UPLOADER_CONFIGRATION.md: strip the GitHub uploader section — it was removed in marktext#4276; PicGo is now the only built-in uploader. - CLI.md: document the `--disable-spellcheck` flag. - FAQ.md: refresh the supported-platforms list (macOS 11+, Windows 10/11, both x64 and arm64 for mac and Windows after marktext#4279) and fix a broken developer-docs link. - THEMES.md: explain that the labels in the Theme menu map to different ids in `preferences.json` (Cadmium Light → `light`, etc.), and fix the `materal-dark.png` typo in the screenshot table. - ENVIRONMENT.md: drop the no-longer-used `MARKTEXT_DEV_HIDE_BROWSER_ANALYZER` row (removed during the electron-vite migration). - BASICS.md: note that the file tree now hosts a collapsible Opened Files subsection toggled via `openedFilesInSidebar` (marktext#4278). - docs/README.md: add a link to IMAGES.md (it existed but wasn't surfaced from the end-user index). - README.md: refresh the platform badge and the macOS / Windows install sections so they describe the actual installer file names (`marktext-mac-(x64|arm64)-%version%.dmg`, `marktext-win-(x64|arm64)-%version%-setup.exe`) and reflect the Windows arm64 build added in marktext#4279. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Companion to #4299. Brings the end-user docs and the top-level README back in line with what 0.19 actually ships.
src/main/preferences/schema.json. Adds the keys that landed since the table was last touched (fileSortOrder,openedFilesInSidebar,wrapCodeBlocks,editorLineWidth,codeBlockLineNumbers,autoNormalizeLineEndings,isHtmlEnabled,isGitlabCompatibilityEnabled,followSystemTheme/lightModeTheme/darkModeTheme,restoreLayoutState,customCss, thespellchecker*trio,imageInsertActionand theimage*relative-directory trio). Fixes stale defaults / enums (startUpActiondefault isrestoreAll,fileSortBydefault ismodified,imageDropActionis nowimageInsertAction).--disable-spellcheckflag.preferences.json(e.g. Cadmium Light →light) and fix themateral-dark.pngtypo in the screenshot table.MARKTEXT_DEV_HIDE_BROWSER_ANALYZERrow.openedFilesInSidebar, feat(sidebar): add toggle to hide Opened Files + cap list to 4 items #4278).IMAGES.md.Test plan
```bash
python3 -c "import json,re;s=set(json.load(open('src/main/preferences/schema.json')).keys());d=set(re.findall(r'\\| (\\w+) +\\|', open('docs/end-user/PREFERENCES.md').read()))-{'Default','Key'};print(sorted(s-d), sorted(d-s))"
```
🤖 Generated with Claude Code