@@ -111,18 +111,18 @@
-Supporting Mark Text
+Supporting MarkText
-Mark Text is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. Mark Text is still in development, and its development is inseparable from all sponsors. I hope you join them:
+MarkText is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. MarkText is still in development, and its development is inseparable from all sponsors. I hope you join them:
- [Become a backer or sponsor on Patreon](https://www.patreon.com/ranluo) or [One time donation](https://github.com/Jocs/sponsor.me)
- [Become a backer or sponsor on Open Collective](https://opencollective.com/marktext)
##### What's the difference between Patreon and Open Collective?
-Patreon: Funds will be directly sponsored to Luo Ran (@jocs) who created Mark Text and continues to maintain it.
-Open Collective: All expenses are transparent. The funds will be used for the development and maintenance of Mark Text, funding online and offline activities, and acquiring other necessary resources.
-Names and company logos of all sponsors (from both Patreon and Open Collective) will appear on the official website for Mark Text and in its README.md file.
+Patreon: Funds will be directly sponsored to Luo Ran (@jocs) who created MarkText and continues to maintain it.
+Open Collective: All expenses are transparent. The funds will be used for the development and maintenance of MarkText, funding online and offline activities, and acquiring other necessary resources.
+Names and company logos of all sponsors (from both Patreon and Open Collective) will appear on the official website for MarkText and in its README.md file.
**Special Sponsors**
@@ -193,9 +193,9 @@ Names and company logos of all sponsors (from both Patreon and Open Collective)
## Why write another editor?
-1. I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. **Mark Text** uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use Mark Text.
-2. As mentioned above, **Mark Text** is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop **Mark Text** into a popular markdown editor.
-3. There are many markdown editors and all have their own merits, some have features which others don't. It's difficult to satisfy each markdown users' needs but we hope **Mark Text** will be able to satisfy each markdown user as much as possible. Although the latest **Mark Text** is still not perfect, we will try to make it as best as we possibly can.
+1. I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. **MarkText** uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use MarkText.
+2. As mentioned above, **MarkText** is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop **MarkText** into a popular markdown editor.
+3. There are many markdown editors and all have their own merits, some have features which others don't. It's difficult to satisfy each markdown users' needs but we hope **MarkText** will be able to satisfy each markdown user as much as possible. Although the latest **MarkText** is still not perfect, we will try to make it as best as we possibly can.
## Download and Installation
@@ -209,7 +209,7 @@ Want to see new features of the latest version? Please refer to [CHANGELOG](.git
#### macOS
-You can either download the latest `marktext-%version%.dmg` from the [release page](https://github.com/marktext/marktext/releases/latest) or install Mark Text using [**homebrew cask**](https://github.com/caskroom/homebrew-cask). To use Homebrew-Cask you just need to have [Homebrew](https://brew.sh/) installed.
+You can either download the latest `marktext-%version%.dmg` from the [release page](https://github.com/marktext/marktext/releases/latest) or install MarkText using [**homebrew cask**](https://github.com/caskroom/homebrew-cask). To use Homebrew-Cask you just need to have [Homebrew](https://brew.sh/) installed.
```bash
brew install --cask mark-text
@@ -217,9 +217,9 @@ brew install --cask mark-text
#### Windows
-Simply download and install Mark Text via setup wizard (`marktext-setup-%version%.exe`) and choose whether to install per-user or machine wide.
+Simply download and install MarkText via setup wizard (`marktext-setup-%version%.exe`) and choose whether to install per-user or machine wide.
-Alternatively, install Mark Text using a package manager such as [Chocolatey](https://chocolatey.org/) or [Winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/).
+Alternatively, install MarkText using a package manager such as [Chocolatey](https://chocolatey.org/) or [Winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/).
- To use Chocolatey you need to have [Chocolatey](https://chocolatey.org/install) installed.
@@ -243,26 +243,26 @@ All binaries for Linux, macOS and Windows can be downloaded from the [release pa
## Development
-If you wish to build **Mark Text** yourself, please check out our [build instructions](docs/dev/BUILD.md).
+If you wish to build **MarkText** yourself, please check out our [build instructions](docs/dev/BUILD.md).
- [User documentation](docs/README.md)
- [Developer documentation](docs/dev/README.md)
-If you have any questions regarding **Mark Text**, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated.
+If you have any questions regarding **MarkText**, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated.
## Integrations
-- [Alfred Workflow](http://www.packal.org/workflow/mark-text): A Workflow for the macOS app Alfred: Use "mt" to open files/folder with Mark Text.
+- [Alfred Workflow](http://www.packal.org/workflow/mark-text): A Workflow for the macOS app Alfred: Use "mt" to open files/folder with MarkText.
## Contribution
-Mark Text is in full development, please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request. Want to add some features to Mark Text? Refer to our [roadmap](https://github.com/marktext/marktext/projects) and open issues.
+MarkText is in full development, please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request. Want to add some features to MarkText? Refer to our [roadmap](https://github.com/marktext/marktext/projects) and open issues.
## Contributors
-Thank you to all the people who have already contributed to Mark Text[[contributors](https://github.com/marktext/marktext/graphs/contributors)]
+Thank you to all the people who have already contributed to MarkText[[contributors](https://github.com/marktext/marktext/graphs/contributors)]
-Special thanks to @[Yasujizr](https://github.com/Yasujizr) who designed the Mark Text logo.
+Special thanks to @[Yasujizr](https://github.com/Yasujizr) who designed the MarkText logo.
diff --git a/docs/BASICS.md b/docs/BASICS.md
index 5f0f65ee..99dbc561 100644
--- a/docs/BASICS.md
+++ b/docs/BASICS.md
@@ -2,7 +2,7 @@
## Getting started
-Mark Text is a realtime preview editor for markdown with various markdown extensions. You can simply write and edit text and Mark Text hides all unnecessary syntax elements. When you first start Mark Text an empty editor window is shown. You can see [key bindings](KEYBINDINGS.md) or command palette (
CmdOrCtrl+
Shift+
P) for all available commands or just type `@` to get an overlay with available text elements. Mark Text provides a minimal and simple interface and in the next sections you can learn more about the interface and features.
+MarkText is a realtime preview editor for markdown with various markdown extensions. You can simply write and edit text and MarkText hides all unnecessary syntax elements. When you first start MarkText an empty editor window is shown. You can see [key bindings](KEYBINDINGS.md) or command palette (
CmdOrCtrl+
Shift+
P) for all available commands or just type `@` to get an overlay with available text elements. MarkText provides a minimal and simple interface and in the next sections you can learn more about the interface and features.
@@ -18,7 +18,7 @@ The sidebar consists of three panels and you can toggle the sidebar by pressing
#### Toggle tabs
-Mark Text can be used as a single editor but opens all files in a separate tab. Tabs can be toggled via
CmdOrCtrl+
Alt+
B and reordered by drag and drop.
+MarkText can be used as a single editor but opens all files in a separate tab. Tabs can be toggled via
CmdOrCtrl+
Alt+
B and reordered by drag and drop.
**Want to use tabs without showing them?**
@@ -38,7 +38,7 @@ Use
CmdOrCtrl+
Shift+
F to enter distraction free
### Open your first file
-You can use the menu `File -> Open File` or press
CmdOrCtrl+
O to open a file dialog to choose a markdown file. Another way to is to launch Mark Text with directories or files via command line.
+You can use the menu `File -> Open File` or press
CmdOrCtrl+
O to open a file dialog to choose a markdown file. Another way to is to launch MarkText with directories or files via command line.
### Save your edited file
@@ -46,7 +46,7 @@ After some modifications you can save your file via
CmdOrCtrl+
S<
### Open a directory
-Mark Text also has support to open a directory via CmdOrCtrl+Shift+O or the sidebar button *Open Folder*. After opening a directory all files and directories are shown in the sidebar tree view. The tree view allows you to open further files, browse and modify files or directories inside the opened root directory. Above the tree view are all opened files located. You can also use quick open (CmdOrCtrl+P) to quickly open a file from the opened root directory or editor and navigate via arrow keys or select a file via mouse. To view another sidebar panel like find in files click on the left sidebar icons.
+MarkText also has support to open a directory via CmdOrCtrl+Shift+O or the sidebar button *Open Folder*. After opening a directory all files and directories are shown in the sidebar tree view. The tree view allows you to open further files, browse and modify files or directories inside the opened root directory. Above the tree view are all opened files located. You can also use quick open (CmdOrCtrl+P) to quickly open a file from the opened root directory or editor and navigate via arrow keys or select a file via mouse. To view another sidebar panel like find in files click on the left sidebar icons.
diff --git a/docs/CLI.md b/docs/CLI.md
index f82251a2..f183fc67 100644
--- a/docs/CLI.md
+++ b/docs/CLI.md
@@ -16,7 +16,7 @@ Usage: marktext [commands] [path ...]
-h, --help Print this help message
```
-`marktext` should point to your installation of Mark Text. The exact location will vary from platform to platform. On macOS, you can create a convenient alias like:
+`marktext` should point to your installation of MarkText. The exact location will vary from platform to platform. On macOS, you can create a convenient alias like:
```sh
alias marktext="/Applications/Mark\ Text.app/Contents/MacOS/Mark\ Text"
diff --git a/docs/EDITING.md b/docs/EDITING.md
index 08739e1c..1f78fda8 100644
--- a/docs/EDITING.md
+++ b/docs/EDITING.md
@@ -4,7 +4,7 @@ Let us take a look at the realtime editor and editing features.
## Text manipulation
-Mark Text shows you formatted text in realtime while you can simply write and edit text but also use markdown syntax. To improve your writing efficiency there are a lot of key bindings for better text manipulation. In the preferences you can control the editor settings such as font settings, autocompletion and line width.
+MarkText shows you formatted text in realtime while you can simply write and edit text but also use markdown syntax. To improve your writing efficiency there are a lot of key bindings for better text manipulation. In the preferences you can control the editor settings such as font settings, autocompletion and line width.
## Selections
@@ -34,7 +34,7 @@ Do you want to delete headings, lists or tables? Just select the area and press
## Brackets and quotes autocompletion
-You can configure Mark Text to autocomplete markdown syntax, brackets and quotes. By default `()`, `[]`, `{}`, `**`, `__`, `$$`, `""` and `''` are completed when the first character is typed.
+You can configure MarkText to autocomplete markdown syntax, brackets and quotes. By default `()`, `[]`, `{}`, `**`, `__`, `$$`, `""` and `''` are completed when the first character is typed.
## Links
@@ -44,7 +44,7 @@ Links are shown by default as normal text but if you click on a link the link is
## Formatting
-Mark Text will automatically format your markdown document according CommonMark and GitHub Flavored Markdown specification. You can control few settings via preferences such as list indentation.
+MarkText will automatically format your markdown document according CommonMark and GitHub Flavored Markdown specification. You can control few settings via preferences such as list indentation.
## Editing features
@@ -62,7 +62,7 @@ You can transform a line into another type by clicking on the highlighted icon i
#### Table tools
-It's sometimes hard to write and manage tables in markdown. In Mark Text you can press CmdOrCtrl+Shift+T to get a table dialog and create a table with variable row and column count. Both row and column count can be changed via the table tools (first icon above the table) later if necessary. You can use all inline styles in a table cell and align the text via table tools at the top of the table.
+It's sometimes hard to write and manage tables in markdown. In MarkText you can press CmdOrCtrl+Shift+T to get a table dialog and create a table with variable row and column count. Both row and column count can be changed via the table tools (first icon above the table) later if necessary. You can use all inline styles in a table cell and align the text via table tools at the top of the table.
**Insert and delete rows and columns:**
@@ -80,7 +80,7 @@ You can simply move a row or column by clicking on the cell menu (like above) an
-Mark Text provides an image viewer and a pop up to select and label images. You can resize any image by your mouse cursor and changes are applied in realtime. By clicking on an image or writing `![]()` a pop up is automatically shown that allows you to select an image from disk or paste a path or URL. Images can be automatically uploaded to cloud, moved to a relative or absolute path on disk. Even pasting images that are not located on disk is supported and these images are stored in the background. In addition, you can control the image alignment whether inline, left, centered or right.
+MarkText provides an image viewer and a pop up to select and label images. You can resize any image by your mouse cursor and changes are applied in realtime. By clicking on an image or writing `![]()` a pop up is automatically shown that allows you to select an image from disk or paste a path or URL. Images can be automatically uploaded to cloud, moved to a relative or absolute path on disk. Even pasting images that are not located on disk is supported and these images are stored in the background. In addition, you can control the image alignment whether inline, left, centered or right.
@@ -102,11 +102,11 @@ In typewriter mode, the cursor is always keep in the middle of the editor.
## File encoding
-Mark Text tries to automatically detect the used file encoding and byte-order mark (BOM) when opening a file. The default encoding is UTF-8 that should support all needed characters but can be changed in settings. You can disable automatically encoding detection but then we assume that all files are UTF-8 encoded. The current used encoding can be shown via command palette and also changed there.
+MarkText tries to automatically detect the used file encoding and byte-order mark (BOM) when opening a file. The default encoding is UTF-8 that should support all needed characters but can be changed in settings. You can disable automatically encoding detection but then we assume that all files are UTF-8 encoded. The current used encoding can be shown via command palette and also changed there.
## Line endings
-Mark Text automatically analyzes each file and detects the used line ending and can be changed via command palette too.
+MarkText automatically analyzes each file and detects the used line ending and can be changed via command palette too.
## Find and replace
@@ -116,4 +116,4 @@ To quickly find a keyword in your document press CmdOrCtrl+F *The SUID sandbox helper binary was found, but is not configured correctly.*
-Normally, you should never get this error but if you disabled user namespaces, this error message may appears in the command output when launching Mark Text. To solve the issue, that Chromium cannot start the sandbox (process), you can choose one of the following steps:
+Normally, you should never get this error but if you disabled user namespaces, this error message may appears in the command output when launching MarkText. To solve the issue, that Chromium cannot start the sandbox (process), you can choose one of the following steps:
- Enable Linux kernel user namespaces to use the preferred sandbox: `sudo sysctl kernel.unprivileged_userns_clone=1`.
- Set correct SUID sandbox helper binary permissions: `sudo chown root /chrome-sandbox && sudo chmod 4755 /chrome-sandbox`. This is prefered if you don't want to enable user namespaces.
-- Launch Mark Text with `--no-sandbox` argument.
+- Launch MarkText with `--no-sandbox` argument.
### What is a "Aidou" ?
diff --git a/docs/IMAGES.md b/docs/IMAGES.md
index ec4be8ed..c80a9a63 100644
--- a/docs/IMAGES.md
+++ b/docs/IMAGES.md
@@ -1,6 +1,6 @@
# Image support
-Mark Text can automatically copy your images into a specified directory or handle images from clipboard.
+MarkText can automatically copy your images into a specified directory or handle images from clipboard.
### Upload to cloud using selected uploader
@@ -14,7 +14,7 @@ All images are automatically copied into the specified local directory that may
When this option is enabled, all images are copied relative to the opened file or the root directory when a project is opened. You can specify the path via the *relative image folder name* text box. The local resource directory is used if the file is not saved.
-NB: The assets directory name must be a valid path name and Mark Text need write access to the directory.
+NB: The assets directory name must be a valid path name and MarkText need write access to the directory.
Examples for relative paths:
@@ -25,4 +25,4 @@ Examples for relative paths:
### Keep original location
-Mark Text only saves images from clipboard into the specified local directory.
+MarkText only saves images from clipboard into the specified local directory.
diff --git a/docs/IMAGE_UPLOADER_CONFIGRATION.md b/docs/IMAGE_UPLOADER_CONFIGRATION.md
index 95eaf006..7ce5fd4a 100644
--- a/docs/IMAGE_UPLOADER_CONFIGRATION.md
+++ b/docs/IMAGE_UPLOADER_CONFIGRATION.md
@@ -14,10 +14,10 @@ No need to config, it's a free uploading service up-to 5MB, thanks!
-3. Config in Mark Text Preferences window. click `CmdOrCtrl + ,` to open Mark Text Preferences window.
+3. Config in MarkText Preferences window. click `CmdOrCtrl + ,` to open MarkText Preferences window.
4. Input you `token`, `owner name` and `repo name` whick you just created. Click `Save` and `Set As default Uploader`.
-5. Paste an image into Mark Text and open you created repo to see the uploaded image.
+5. Paste an image into MarkText and open you created repo to see the uploaded image.
diff --git a/docs/KEYBINDINGS.md b/docs/KEYBINDINGS.md
index 2784bed9..fe863077 100644
--- a/docs/KEYBINDINGS.md
+++ b/docs/KEYBINDINGS.md
@@ -30,14 +30,14 @@ Here is an example:
## Available id's
-**Mark Text menu (macOS only):**
+**MarkText menu (macOS only):**
| Id | Default | Description |
| ------------------ | ---------------------------------------------- | --------------------------------------- |
-| `mt.hide` | Command+H | Hide Mark Text |
-| `mt.hide-others` | Command+Alt+H | Hide all other windows except Mark Text |
+| `mt.hide` | Command+H | Hide MarkText |
+| `mt.hide-others` | Command+Alt+H | Hide all other windows except MarkText |
| `file.preferences` | Command+, | Open settings window |
-| `file.quit` | Command+Q | Quit Mark Text |
+| `file.quit` | Command+Q | Quit MarkText |
**File menu:**
@@ -53,7 +53,7 @@ Here is an example:
| `file.preferences` | Ctrl+, | Open settings window (Linux/Windows only) |
| `file.close-tab` | CmdOrCtrl+W | Close tab |
| `file.close-window` | CmdOrCtrl+Shift+W | Close window |
-| `file.quit` | CmdOrCtrl+Q | Quit Mark Text (Linux/Windows only) |
+| `file.quit` | CmdOrCtrl+Q | Quit MarkText (Linux/Windows only) |
**Edit menu:**
diff --git a/docs/LINUX.md b/docs/LINUX.md
index 66cdca47..ed0a0699 100644
--- a/docs/LINUX.md
+++ b/docs/LINUX.md
@@ -6,7 +6,7 @@
1. `chmod +x marktext-%version%-x86_64.AppImage`
2. `./marktext-%version%-x86_64.AppImage`
-3. Now you can execute Mark Text.
+3. Now you can execute MarkText.
### Installation
@@ -48,7 +48,7 @@ You can integrate the AppImage into the system via [AppImageLauncher](https://gi
### Known issues
-- Mark Text is always integrated into desktop environment after updating
+- MarkText is always integrated into desktop environment after updating
## Binary
@@ -64,7 +64,7 @@ You need to install the `flatpak` package for your distribution. Please see the
**Install from Flathub:**
-After you install flatpak and flathub repository, you can install [Mark Text](https://flathub.org/apps/details/com.github.marktext.marktext) with just one command (note that you may be asked to enter your password):
+After you install flatpak and flathub repository, you can install [MarkText](https://flathub.org/apps/details/com.github.marktext.marktext) with just one command (note that you may be asked to enter your password):
```
flatpak install flathub com.github.marktext.marktext
@@ -72,11 +72,11 @@ flatpak install flathub com.github.marktext.marktext
or `flatpak install --user flathub com.github.marktext.marktext` to install for the current user only.
-To run Mark Text just execute `flatpak run com.github.marktext.marktext` or click on the Mark Text icon in your application launcher.
+To run MarkText just execute `flatpak run com.github.marktext.marktext` or click on the MarkText icon in your application launcher.
### Update
-To update Mark Text run the following command:
+To update MarkText run the following command:
```
flatpak update com.github.marktext.marktext
diff --git a/docs/MARKDOWN_SYNTAX.md b/docs/MARKDOWN_SYNTAX.md
index de0b6527..0c812e1c 100644
--- a/docs/MARKDOWN_SYNTAX.md
+++ b/docs/MARKDOWN_SYNTAX.md
@@ -235,18 +235,18 @@ Note that placement of achors is arbitrary, you can put them anywhere you want,
Images have a similar syntax to links but include a preceding exclamation point.
```markdown
-
+
```
-
+
or
```markdown
-
+
```
-
+
Like links, Images also have a footnote style syntax
@@ -258,10 +258,10 @@ Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
-[id]: https://raw.githubusercontent.com/marktext/marktext/develop/resources/icons/256x256/marktext.png "Mark Text logo"
+[id]: https://raw.githubusercontent.com/marktext/marktext/develop/resources/icons/256x256/marktext.png "MarkText logo"
```markdown
-[id]: https://raw.githubusercontent.com/marktext/marktext/develop/resources/icons/256x256/marktext.png "Mark Text logo"
+[id]: https://raw.githubusercontent.com/marktext/marktext/develop/resources/icons/256x256/marktext.png "MarkText logo"
```
@@ -639,7 +639,7 @@ Which renders to:
:heart: :zap: :cow: :dollar: :star: :tada:
-**NOTE:** Mark Text provides an emoji picker with search functionality.
+**NOTE:** MarkText provides an emoji picker with search functionality.
@@ -728,7 +728,7 @@ $$
## Diagrams
-Mark Text support class, flow chart, gantt and sequence diagrams powered by flowchart.js, mermaid and Vega-Lite. [Code](#code) blocks with special language identifiers are used for diagrams.
+MarkText support class, flow chart, gantt and sequence diagrams powered by flowchart.js, mermaid and Vega-Lite. [Code](#code) blocks with special language identifiers are used for diagrams.
For example, this:
diff --git a/docs/PORTABLE.md b/docs/PORTABLE.md
index 6a6f1fe7..f5c8b76b 100644
--- a/docs/PORTABLE.md
+++ b/docs/PORTABLE.md
@@ -1,6 +1,6 @@
# Portable Mode
-Mark Text stores all user configuration inside the [application data directory](APPLICATION_DATA_DIRECTORY.md) that can be changed with `--user-data-dir` command-line flag.
+MarkText stores all user configuration inside the [application data directory](APPLICATION_DATA_DIRECTORY.md) that can be changed with `--user-data-dir` command-line flag.
## Linux and Windows
@@ -8,7 +8,7 @@ On Linux and Windows you can also create a directory called `marktext-user-data`
```
marktext-portable/
- ├── marktext (Linux) or Mark Text.exe (Windows)
+ ├── marktext (Linux) or MarkText.exe (Windows)
├── marktext-user-data/
├── resources/
├── THIRD-PARTY-LICENSES.txt
diff --git a/docs/PREFERENCES.md b/docs/PREFERENCES.md
index 8c003cb3..280ce279 100644
--- a/docs/PREFERENCES.md
+++ b/docs/PREFERENCES.md
@@ -1,4 +1,4 @@
-## Mark Text Preferences
+## MarkText Preferences
Preferences can be controlled and modified in the settings window or via the `preferences.json` file in the [application data directory](APPLICATION_DATA_DIRECTORY.md).
@@ -15,9 +15,9 @@ Preferences can be controlled and modified in the settings window or via the `pr
| wordWrapInToc | Boolean | false | Whether to enable word wrap in TOC. Optional value: true, false |
| aidou | Boolean | true | Enable aidou. Optional value: true, false |
| fileSortBy | String | created | Sort files in opened folder by `created` time, modified time and title. |
-| startUpAction | String | lastState | The action after Mark Text startup, open the last edited content, open the specified folder or blank page, optional value: `lastState`, `folder`, `blank` |
+| startUpAction | String | lastState | The action after MarkText startup, open the last edited content, open the specified folder or blank page, optional value: `lastState`, `folder`, `blank` |
| defaultDirectoryToOpen | String | `""` | The path that should be opened if `startUpAction=folder`. |
-| language | String | en | The language Mark Text use. |
+| language | String | en | The language MarkText use. |
#### Editor
@@ -35,7 +35,7 @@ Preferences can be controlled and modified in the settings window or via the `pr
| codeFontFamily | String | `DejaVu Sans Mono` | Code font family |
| trimUnnecessaryCodeBlockEmptyLines | Boolean | true | Whether to trim the beginning and end empty line in Code block |
| hideQuickInsertHint | Boolean | false | Hide hint for quickly creating paragraphs |
-| imageDropAction | String | folder | The default behavior after paste or drag the image to Mark Text, upload it to the image cloud (if configured), move to the specified folder, insert the path |
+| imageDropAction | String | folder | The default behavior after paste or drag the image to MarkText, upload it to the image cloud (if configured), move to the specified folder, insert the path |
| defaultEncoding | String | `utf8` | The default file encoding |
| autoGuessEncoding | Boolean | true | Try to automatically guess the file encoding when opening files |
| trimTrailingNewline | Enum | `2` | Ensure a single trailing newline or whether trailing newlines should be removed: `0`: trim all trailing newlines, `1`: ensure single newline, `2`: auto detect, `3`: disabled. |
@@ -49,7 +49,7 @@ Preferences can be controlled and modified in the settings window or via the `pr
| preferLooseListItem | Boolean | true | The preferred list type. |
| bulletListMarker | String | `-` | The preferred marker used in bullet list, optional value: `-`, `*` `+` |
| orderListDelimiter | String | `.` | The preferred delimiter used in order list, optional value: `.` `)` |
-| preferHeadingStyle | String | `atx` | The preferred heading style in Mark Text, optional value `atx` `setext`, [more info](https://spec.commonmark.org/0.29/#atx-headings) |
+| preferHeadingStyle | String | `atx` | The preferred heading style in MarkText, optional value `atx` `setext`, [more info](https://spec.commonmark.org/0.29/#atx-headings) |
| tabSize | Number | 4 | The number of spaces a tab is equal to |
| listIndentation | String | 1 | The list indentation of sub list items or paragraphs, optional value `dfm`, `tab` or number 1~4 |
| frontmatterType | String | `-` | The frontmatter type: `-` (YAML), `+` (TOML), `;` (JSON) or `{` (JSON) |
diff --git a/docs/README.md b/docs/README.md
index 28f31d4a..457d68af 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,6 @@
# User Documentation
-Welcome to the end-user documentation of Mark Text.
+Welcome to the end-user documentation of MarkText.
diff --git a/docs/SPELLING.md b/docs/SPELLING.md
index 359444a2..2aa345f6 100644
--- a/docs/SPELLING.md
+++ b/docs/SPELLING.md
@@ -1,6 +1,6 @@
# Spelling
-Mark Text can automatically check your text for misspelled words as you type and suggest corrections. You just need to enable spell checking in settings under *spelling* to never miss a misspelled word. We're using Hunspell for Linux and older Windows versions and on macOS and Window 10 you can choose between Hunspell or the system spell checker (default). You can control the default proofing language via settings but can change the language at runtime via right-click menu `Change Language` entry under `Spelling` without changing the default language. By default Mark Text only support American English for Hunspell and the local available languages for the system spell checker. You can download 42 languages for Hunspell and many more for macOS and Windows 10 via system settings.
+MarkText can automatically check your text for misspelled words as you type and suggest corrections. You just need to enable spell checking in settings under *spelling* to never miss a misspelled word. We're using Hunspell for Linux and older Windows versions and on macOS and Window 10 you can choose between Hunspell or the system spell checker (default). You can control the default proofing language via settings but can change the language at runtime via right-click menu `Change Language` entry under `Spelling` without changing the default language. By default MarkText only support American English for Hunspell and the local available languages for the system spell checker. You can download 42 languages for Hunspell and many more for macOS and Windows 10 via system settings.
@@ -8,7 +8,7 @@ Mark Text can automatically check your text for misspelled words as you type and
**Automatic language detection:**
-Mark Text can try to automatically detect the language while typing and we're currently support over 160 languages by Compact Language Detector.
+MarkText can try to automatically detect the language while typing and we're currently support over 160 languages by Compact Language Detector.
**Don't underline misspelled words:**
diff --git a/docs/THEMES.md b/docs/THEMES.md
index 5a81854c..49ccd05a 100644
--- a/docs/THEMES.md
+++ b/docs/THEMES.md
@@ -1,3 +1,3 @@
# Themes
-Mark Text currently doesn't support user-defined application themes. This feature is planned for v0.17.0.
+MarkText currently doesn't support user-defined application themes. This feature is planned for v0.17.0.
diff --git a/docs/dev/ARCHITECTURE.md b/docs/dev/ARCHITECTURE.md
index 5fe7b75c..3eb9c4cd 100644
--- a/docs/dev/ARCHITECTURE.md
+++ b/docs/dev/ARCHITECTURE.md
@@ -9,21 +9,21 @@
- `docs/`: Documentation and assets
- `resources/`: Application assets using at build time
- `node_modules/`: Dependencies
-- `src`: Mark Text source code
+- `src`: MarkText source code
- `common/`: Common source files that only require Node.js APIs. Code from this folder can be used in all other folders except `muya`.
- `main/`: Main process source files that require Electron main-process APIs. `main` files can use `common` source code.
- - `muya/`: Mark Texts backend that only allow pure JavaScript, BOM and DOM APIs. Don't use Electron or Node.js APIs!
+ - `muya/`: MarkTexts backend that only allow pure JavaScript, BOM and DOM APIs. Don't use Electron or Node.js APIs!
- `renderer`: Frontend that require Electron renderer-process APIs and may use `common` or `muya` source code.
- `static/`: Application assets (images, themes, etc)
- `test/`: Contains (unit) tests
-## Introduction to Mark Text
+## Introduction to MarkText
-Mark Text is a realtime preview (WYSIWYG) editor for markdown with various markdown extensions and our philosophy is to keep things clean, simple and minimal. The application is build with HTML, JS and CSS on top of Electron. Currently we're using a few native node libraries and our UI is build with Vue/Vuex. Mark Text can be split in three parts: the core called Muya, the main- and renderer process.
+MarkText is a realtime preview (WYSIWYG) editor for markdown with various markdown extensions and our philosophy is to keep things clean, simple and minimal. The application is build with HTML, JS and CSS on top of Electron. Currently we're using a few native node libraries and our UI is build with Vue/Vuex. MarkText can be split in three parts: the core called Muya, the main- and renderer process.
-Muya provides realtime preview and markdown editing via multiple modules based on a block structure. You can imagine it as the editor backend with modules for markdown parsing, data store as block structure, markdown document transformations according CommonMark and GitHub Flavored Markdown specification with some extra specifications, event listeners and an exporter to generate standalone HTML and markdown files but also to generate the WYSIWYG editor. Muya is single threaded as well as Mark Text but use asynchronous functions to boost performance.
+Muya provides realtime preview and markdown editing via multiple modules based on a block structure. You can imagine it as the editor backend with modules for markdown parsing, data store as block structure, markdown document transformations according CommonMark and GitHub Flavored Markdown specification with some extra specifications, event listeners and an exporter to generate standalone HTML and markdown files but also to generate the WYSIWYG editor. Muya is single threaded as well as MarkText but use asynchronous functions to boost performance.
-> NOTE: Mark Text's source-code editor is provided by CodeMirror and not well optimized nor feature rich. It's not part of Muya and an editor (renderer process) feature that load the markdown text from Muya (export), operate on it and re-import the text into Muya when switching to preview mode.
+> NOTE: MarkText's source-code editor is provided by CodeMirror and not well optimized nor feature rich. It's not part of Muya and an editor (renderer process) feature that load the markdown text from Muya (export), operate on it and re-import the text into Muya when switching to preview mode.
> NOTE: Muya requires a core refactoring to provide better modularization, APIs and plugins. Furthermore, the data structure need improvements for better performance and stability.
diff --git a/docs/dev/BUILD.md b/docs/dev/BUILD.md
index 94e83c26..3b166494 100644
--- a/docs/dev/BUILD.md
+++ b/docs/dev/BUILD.md
@@ -35,8 +35,8 @@ On Red Hat-based Linux: `sudo dnf install libX11-devel libxkbfile-devel libsecre
1. Go to `marktext` folder
2. Install dependencies: `yarn install` or `yarn install --frozen-lockfile`
-3. Build Mark Text binaries and packages: `yarn run build`
-4. Mark Text binary is located under `build` folder
+3. Build MarkText binaries and packages: `yarn run build`
+4. MarkText binary is located under `build` folder
Copy the build app to applications folder, or if on Windows run the executable installer.
@@ -48,9 +48,9 @@ $ yarn run 