Update documentation (#1548)

* Update documentation

* Remove <br> due to issues with preview
This commit is contained in:
Felix Häusler 2019-10-28 00:53:30 +01:00 committed by Ran Luo
parent 9c8f14cfd2
commit 8436aeb499
16 changed files with 105 additions and 8 deletions

View File

@ -6,3 +6,4 @@ The per-user application data directory is located in the following directory:
- `$XDG_CONFIG_HOME/marktext` or `~/.config/marktext` on Linux - `$XDG_CONFIG_HOME/marktext` or `~/.config/marktext` on Linux
- `~/Library/Application Support/marktext` on macOS - `~/Library/Application Support/marktext` on macOS
When [portable mode](PORTABLE.md) is enabled, the directory location is either the `--user-data-dir` parameter or `marktext-user-data` directory.

View File

@ -62,13 +62,19 @@ You can transform a line into another type by clicking on the highlighted icon i
#### Table tools #### Table tools
It's sometimes hard to write and manage tables in markdown. In Mark Text you can press <kbd>CmdOrCtrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> 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 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 Mark Text you can press <kbd>CmdOrCtrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> 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:** **Insert and delete rows and columns:**
You can insert or delete a new row or column by right clicking on an existing cell and click on `Insert Row/Column` or `Remove Row/Column`. You can insert or delete a new row or column by clicking on an existing cell and click on the menu on the right side for rows or bottom for columns.
![](assets/marktext-table-tools.png) ![](assets/marktext-table_drag_drop.png)
**Move table cells:**
You can simply move a row or column by clicking on the cell menu (like above) and dragging it by holding your mouse left-button like this:
![](assets/marktext-table-gif.gif)
#### Image tools #### Image tools

29
docs/EXPORT.md Normal file
View File

@ -0,0 +1,29 @@
# Export a Document
Mark Text allows you to export a markdown document as PDF and HTML file or to print the document.
## Options
### Page options
You can set the page size, orientation and margin before exporting a document.
### Style
Adjust the page style without modify the page theme:
- Overwrite font family, size and line height.
- Auto numbering headings.
- Option to show the front matter on the exported document.
### Theme
Mark Text allows you to select a page theme before exporting. You can learn more about page themes [here](EXPORT_THEMES.md).
### Header and footer
You can include a header and/or footer in the exported document if you choose PDF or printing and also adjust the header/footer style. You can select between no, a single or a three cell header in export options. The header and/or footer appear on each page when defined and the header can be multiline but the footer only single line. Unfortunately, page numbering is currently not supported. An example can be seen below.
![](assets/marktext-export-header.png)
![](assets/marktext-export-pdf.png)

23
docs/EXPORT_THEMES.md Normal file
View File

@ -0,0 +1,23 @@
# Themes (Export)
Mark Text allows you to modify the appearance of the document that you want to export. By default we provide three themes: Academic, GitHub and Liber (writing theme).
## Install a theme
You can install a theme by copying the `.css` file to the [application data directory](APPLICATION_DATA_DIRECTORY.md) location but you may need to restart Mark Text to detect the theme.
## Create a theme
Mark Text use the GitHub theme as basic style that is always available. A custom theme can add additional styles but have to overwrite the GitHub style to make changes such as font family or the underling for heading. You can see all predefined styles [here](https://github.com/sindresorhus/github-markdown-css/blob/gh-pages/github-markdown.css). An example for custom themes can be found [here](https://github.com/marktext/marktext/blob/develop/src/renderer/assets/themes/export/academic.theme.css) and [here](https://github.com/marktext/marktext/blob/develop/src/renderer/assets/themes/export/liber.theme.css).
### Theme settings
A theme currently only have a name (`A-z0-9 -`) that is defined by a CSS comment at the first line like:
```css
/** Liber **/
.markdown-body {
/* ... */
}
```

View File

@ -804,7 +804,7 @@ sequenceDiagram
loop Healthcheck loop Healthcheck
John->>John: Fight against hypochondria John->>John: Fight against hypochondria
end end
Note right of John: Rational thoughts <br/>prevail! Note right of John: Some note
John-->>Alice: Great! John-->>Alice: Great!
John->>Bob: How about you? John->>Bob: How about you?
Bob-->>John: Jolly good! Bob-->>John: Jolly good!

View File

@ -8,6 +8,7 @@ Welcome to the end-user documentation of Mark Text.
- [Basics](BASICS.md) - [Basics](BASICS.md)
- [Editing in depth](EDITING.md) - [Editing in depth](EDITING.md)
- [Spelling](SPELLING.md)
- [Markdown syntax](MARKDOWN_SYNTAX.md) - [Markdown syntax](MARKDOWN_SYNTAX.md)
**Further documents:** **Further documents:**
@ -16,10 +17,13 @@ Welcome to the end-user documentation of Mark Text.
- [Application data directory](APPLICATION_DATA_DIRECTORY.md) - [Application data directory](APPLICATION_DATA_DIRECTORY.md)
- [Command line interface](CLI.md) - [Command line interface](CLI.md)
- [Environment variables](ENVIRONMENT.md) - [Environment variables](ENVIRONMENT.md)
- [Image uploader configration](IMAGE_UPLOADER_CONFIGRATION.md) - [Export a document](EXPORT.md)
- [Image uploader configuration](IMAGE_UPLOADER_CONFIGRATION.md)
- [Installation instructions](../README.md#download-and-installation) - [Installation instructions](../README.md#download-and-installation)
- [Key bindings](KEYBINDINGS.md) - [Key bindings](KEYBINDINGS.md)
- [Portable mode](PORTABLE.md) - [Portable mode](PORTABLE.md)
- [Preferences](PREFERENCES.md) - [Preferences](PREFERENCES.md)
- [Themes](THEMES.md)
- [Themes for exporting](EXPORT_THEMES.md)
Interested in developer documentation? Please see [here](dev/README.md). Interested in developer documentation? Please see [here](dev/README.md).

31
docs/SPELLING.md Normal file
View File

@ -0,0 +1,31 @@
# 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 Windows and on macOS 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 macOS spell checker. You can download 42 languages for Hunspell and many more for macOS.
![](assets/marktext-spellchecker-menu.png)
## Features
**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.
**Don't underline misspelled words:**
If you don't like that all spelling mistakes are red highlighted, you can disable this feature in settings but still benefit from manually spell checking via right-click menu. Disabling constantly spell checking will also improve performance overall.
**Adding words to dictionary:**
You can add words to the selected dictionary by right-clicking on a misspelled word and select `Add to Dictionary` or remove a previously added word. If you want to temporary ignore a word, select `Ignore`.
## Manage dictionaries
### macOS spell checker
You need to add the needed language dictionaries via *Language & Region* in your system preferences pane.
### Hunspell
Please go to spelling settings and scroll to the bottom. Now you see a list of available language dictionaries and can add additional dictionaries via the drop-down menu at the bottom. Please note that an active internet connection is required to download a dictionary!
![](assets/marktext-spelling-settings.png)

3
docs/THEMES.md Normal file
View File

@ -0,0 +1,3 @@
# Themes
Mark Text currently doesn't support user-defined application themes. This feature is planned for v0.17.0.

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 643 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

@ -33,7 +33,7 @@ The editor represents the view and is split into two parts. The first is the mai
There are two entry points to the application: There are two entry points to the application:
- `src/main/index.js` for the main process that is executed first and only once per instance. Once the application is initialized, it's safe to access all the environment variables and single-instances and the application (`App`) is started (`src/main/app/index.js`). You can use the application after `App::init()` is run sucessfully. - `src/main/index.js` for the main process that is executed first and only once per instance. Once the application is initialized, it's safe to access all the environment variables and single-instances and the application (`App`) is started (`src/main/app/index.js`). You can use the application after `App::init()` is run successfully.
- `src/renderer/main.js` for each editor window. At the beginning libraries are loaded, the window is initialized and Vue components are mounted. - `src/renderer/main.js` for each editor window. At the beginning libraries are loaded, the window is initialized and Vue components are mounted.
### How Muya work ### How Muya work

View File

@ -140,10 +140,10 @@ export const HUNSPELL_DICTIONARY_LANGUAGE_MAP = [{
label: 'Cрпски језик (Latin)', // Serbian (Latin) label: 'Cрпски језик (Latin)', // Serbian (Latin)
value: 'sh' // aka sr-Latn value: 'sh' // aka sr-Latn
}, { }, {
label: 'Slovenčina', // Slovak label: 'Slovenčina (sk-SK)', // Slovak
value: 'sk-SK' value: 'sk-SK'
}, { }, {
label: 'Slovenščina', // Slovene label: 'Slovenščina (sl-SI)', // Slovene
value: 'sl-SI' value: 'sl-SI'
}, { }, {
label: 'Shqip', // Albanian label: 'Shqip', // Albanian