-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #88 from NeilWB/gh-pages
Some tweaks to the wording.
- Loading branch information
Showing
21 changed files
with
501 additions
and
501 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,9 +24,9 @@ Table of Contents | |
|
||
### Paragraph and line breaks | ||
|
||
A paragraph is simply one or more consecutive lines of text. In markdown source code, paragraphs are separated by two or more blank lines. In Typora, you only need one blank line (press `Return` once) to create a new paragraph. | ||
A paragraph is simply one or more consecutive lines of text. In Markdown source code, paragraphs are separated by two or more blank lines. In Typora, you only need one blank line (press <kbd>Return</kbd> once) to create a new paragraph. | ||
|
||
Press `Shift` + `Return` to create a single line break. Most other markdown parsers will ignore single line breaks, so in order to make other markdown parsers recognize your line break, you can leave two spaces at the end of the line, or insert `<br/>`. | ||
Press <kbd>Shift</kbd> + <kbd>Return</kbd> to create a single line break. Most other Markdown parsers will ignore single line breaks, so in order to make other Markdown parsers recognize your line break, you can leave two spaces at the end of the line, or insert `<br/>`. | ||
|
||
### Headings | ||
|
||
|
@@ -40,7 +40,7 @@ Headings use 1-6 hash (`#`) characters at the start of the line, corresponding t | |
###### This is an H6 | ||
``` | ||
|
||
In Typora, input ‘#’s followed by title content, and press `Return` key will create a heading. Or type ⌘1 to ⌘6 as a shortcut. | ||
In Typora, input ‘#’s followed by title content, then pressing the <kbd>Return</kbd> key will create a heading. Or type ⌘1 to ⌘6 as a shortcut. | ||
|
||
### Blockquotes | ||
|
||
|
@@ -56,7 +56,7 @@ Markdown uses email-style > characters for blockquoting. They are presented as: | |
> This is another blockquote with one paragraph. There are three empty lines to separate two blockquotes. | ||
``` | ||
|
||
In Typora, typing ‘>’ followed by your quote contents will generate a quote block. Typora will insert a proper ‘>’ or line break for you. Nested block quotes (a block quote inside another block quote) by adding additional levels of ‘>’. | ||
In Typora, typing ‘>’ followed by your quote contents will generate a quote block. Typora will insert a proper ‘>’ or line break for you. Nest block quotes (a block quote inside another block quote) by adding additional levels of ‘>’. | ||
|
||
### Lists | ||
|
||
|
@@ -96,7 +96,7 @@ You can change the complete/incomplete state by clicking on the checkbox before | |
|
||
Typora only supports fences in GitHub Flavored Markdown, not the original code block style. | ||
|
||
Using fences is easy: type \`\`\` and press `return`. Add an optional language identifier after \`\`\` and Typora runs it through syntax highlighting: | ||
Using fences is easy: type \`\`\` and press <kbd>Return</kbd>. Add an optional language identifier after \`\`\` and Typora runs it through syntax highlighting: | ||
|
||
````markdown | ||
Here's an example: | ||
|
@@ -119,7 +119,7 @@ puts markdown.to_html | |
|
||
You can render *LaTeX* mathematical expressions using **MathJax**. | ||
|
||
To add a mathematical expression, enter `$$` and press the 'Return' key. This will trigger an input field that accepts *Tex/LaTex* source. For example: | ||
To add a mathematical expression, enter `$$` and press the <kbd>Return</kbd> key. This will trigger an input field that accepts *Tex/LaTex* source. For example: | ||
|
||
|
||
$$ | ||
|
@@ -131,7 +131,7 @@ $$ | |
$$ | ||
|
||
|
||
In the markdown source file, the math block is a *LaTeX* expression wrapped by a pair of ‘$$’ marks: | ||
In the Markdown source file, the math block is a *LaTeX* expression wrapped by a pair of ‘$$’ marks: | ||
|
||
``` markdown | ||
$$ | ||
|
@@ -147,15 +147,15 @@ You can find more details [here](http://support.typora.io/Math/). | |
|
||
### Tables | ||
|
||
Standard Markdown has been extended in several ways to add table support., including by GFM. Typora supports this with a graphical interface, or writing the source code directly. | ||
Standard Markdown has been extended in several ways to add table support, including by GFM. Typora supports this with a graphical interface or by writing the source code directly. | ||
|
||
Enter `| First Header | Second Header |` and press the `return` key. This will create a table with two columns. | ||
Enter `| First Header | Second Header |` and press the <kbd>Return</kbd> key. This will create a table with two columns. | ||
|
||
After a table is created, placing the focus on that table will open up a toolbar for the table where you can resize, align, or delete the table. You can also use the context menu to copy and add/delete individual columns/rows. | ||
|
||
The full syntax for tables is described below, but it is not necessary to know the full syntax in detail as the markdown source code for tables is generated automatically by Typora. | ||
The full syntax for tables is described below but it is not necessary to know the full syntax in detail as the Markdown source code for tables is generated automatically by Typora. | ||
|
||
In markdown source code, they look like: | ||
In Markdown source code, they look like: | ||
|
||
``` markdown | ||
| First Header | Second Header | | ||
|
@@ -164,9 +164,9 @@ In markdown source code, they look like: | |
| Content Cell | Content Cell | | ||
``` | ||
|
||
You can also include inline Markdown such as links, bold, italics, or strikethrough in the table. | ||
You can also include inline Markdown such as links, bold, italics or strikethrough in the table. | ||
|
||
By including colons (`:`) within the header row, you can set text in that column to be left-aligned, right-aligned, or center-aligned: | ||
By including colons (`:`) within the header row, you can set text in that column to be left-aligned, right-aligned or center-aligned: | ||
|
||
``` markdown | ||
| Left-Aligned | Center Aligned | Right Aligned | | ||
|
@@ -196,33 +196,33 @@ You can create footnotes like this[^fn1] and this[^fn2]. | |
[^fn2]: Here is the *text* of the second **footnote**. | ||
``` | ||
|
||
Hover over the ‘fn1’ or 'fn2' superscript to see the content of the footnote. You can use whatever unique identified you like as the footnote marker (e.g. "fn1"). | ||
Hover over the ‘fn1’ or 'fn2' superscript to see the content of the footnote. You can use whatever unique identifier you like as long as it matches the footnote marker (e.g. "fn1"). | ||
|
||
Hover over the footnote superscripts to see the content of the footnote. | ||
|
||
### Horizontal Rules | ||
|
||
Entering `***` or `---` on a blank line and pressing `return` will draw a horizontal line. | ||
Entering `***` or `---` on a blank line and pressing <kbd>Return</kbd> will draw a horizontal line. | ||
|
||
------ | ||
|
||
### YAML Front Matter | ||
|
||
Typora now supports [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/). Enter `---` at the top of the article and then press `Return` to introduce a metadata block. Alternatively, you can insert a metadata block from the top menu of Typora. | ||
Typora now supports [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/). Enter `---` at the top of the article and then press <kbd>Return</kbd> to introduce a metadata block. Alternatively, you can insert a metadata block from the top menu of Typora. | ||
|
||
### Table of Contents (TOC) | ||
|
||
Enter `[toc]` and press the `Return` key to create a “Table of Contents” section. The TOC extracts all headings from the document, and its contents are updated automatically as you add to the document. | ||
Enter `[toc]` and press the <kbd>Return</kbd> key to create a “Table of Contents” section. The TOC extracts all headings from the document and its contents are updated automatically as you add to the document. | ||
|
||
### Callouts / Github Style Alerts | ||
|
||
To use this feature, please enable in preferences panel first. | ||
To use this feature, please enable it in the preferences panel first. | ||
|
||
[See here for more details](/What's-New-1.8/). | ||
|
||
## Span Elements | ||
|
||
Span elements will be parsed and rendered right after typing. Moving the cursor in the middle of those span elements will expand those elements into the markdown source. Below is an explanation of the syntax for each span element. | ||
Span elements will be parsed and rendered right after typing. Moving the cursor to the middle of a span element will expand that element into the Markdown source. Below is an explanation of the syntax for each span element. | ||
|
||
### Links | ||
|
||
|
@@ -282,27 +282,27 @@ And then define the link: | |
[Google]: http://google.com/ | ||
``` | ||
|
||
In Typora, clicking the link will expand it for editing, and command+click will open the hyperlink in your web browser. | ||
In Typora, clicking the link will expand it for editing, and <kbd>Command</kbd> + click will open the hyperlink in your web browser. | ||
|
||
### URLs | ||
### URL's | ||
|
||
Typora allows you to insert URLs as links, wrapped by `<`brackets`>`. For example `<[email protected]>` becomes <[email protected]>. | ||
Typora allows you to insert URL's as links, wrapped by `<`brackets`>`. For example `<[email protected]>` becomes <[email protected]>. | ||
|
||
Typora will also automatically link standard URLs (for example: www.google.com) without these brackets. | ||
|
||
### Images | ||
|
||
Images have similar syntax as links, but they require an additional `!` char before the start of the link. The syntax for inserting an image looks like this: | ||
Images have similar syntax as links but they require an additional `!` char before the start of the link. The syntax for inserting an image looks like this: | ||
|
||
``` markdown | ||
 | ||
|
||
 | ||
``` | ||
|
||
You are able to use drag and drop to insert an image from an image file or your web browser. You can modify the markdown source code by clicking on the image. A relative path will be used if the image that is added using drag and drop is in same directory or sub-directory as the document you're currently editing. | ||
You are able to use drag and drop to insert an image from an image file or your web browser. You can modify the Markdown source code by clicking on the image. A relative path will be used if the image that is added using drag and drop is in the same directory or sub-directory as the document you're currently editing. | ||
|
||
If you’re using markdown for building websites, you may specify a URL prefix for the image preview on your local computer with the property `typora-root-url` in YAML Front Matter. For example, Enter `typora-root-url:/User/Abner/Website/typora.io/` in YAML Front Matter, and then `` will be treated as `` in Typora. | ||
If you’re using Markdown for building websites, you may specify a URL prefix for the image preview on your local computer with the property `typora-root-url` in YAML Front Matter. For example, enter `typora-root-url:/User/Abner/Website/typora.io/` in YAML Front Matter, and then `` will be treated as `` in Typora. | ||
|
||
 | ||
|
||
|
@@ -382,7 +382,7 @@ Entering UTF-8 emoji characters directly is also supported by going to `Edit` -> | |
|
||
To use this feature, please enable it first in the `Markdown` tab of the preference panel. Then, use `$` to wrap a LaTeX command. For example: `$\lim_{x \to \infty} \exp(-x) = 0$`. | ||
|
||
To trigger inline preview for inline math: input “$”, then press the `ESC` key, then input a TeX command. | ||
To trigger an inline preview for inline math: input “$”, then press the <kbd>ESC</kbd> key followed by inputting a TeX command. | ||
|
||
You can find more details [here](http://support.typora.io/Math/). | ||
|
||
|
@@ -400,7 +400,7 @@ To use this feature, please enable it first in the `Markdown` tab of the prefere | |
|
||
## HTML | ||
|
||
You can use HTML to style content where pure Markdown does not support. For example, use `<span style="color:red">this text is red</span>` to add text with red color. | ||
You can use HTML to style content where pure Markdown does not provide support. For example, use `<span style="color:red">this text is red</span>` to add text with the color red. | ||
|
||
### Underlines | ||
|
||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,22 +10,22 @@ typora-root-url: ../../ | |
|
||
# Welcome | ||
|
||
Thank you for choosing **Typora**. This document will help you to start Typora. | ||
Thank you for choosing **Typora**. This document will help you get started with Typora. | ||
|
||
* Outline | ||
{:toc} | ||
|
||
## Live Preview | ||
|
||
**Typora** uses the feature: *Live Preview*, meaning that you could see these inline styles after you finish typing, and see block styles when you type or after you press `Enter` key or focus to another paragraph. Just try to type some markdown in typora, and you would see how it works. | ||
**Typora** uses the feature: *Live Preview*, meaning that you can see inline styles as soon as you finish typing them and see block styles as you type or after you press the <kbd>Enter</kbd> key to focus on the next paragraph. Just try typing some Markdown in Typora, and you would see how it works. | ||
|
||
**Note**: Markdown tags for inline styles, such as `**` will be hidden or displayed smartly. Markdown tags for block level styles, such as `###` or `- [x]` will be hidden once the block is rendered. | ||
|
||
## Markdown For Typora | ||
|
||
**Typora** is using [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/), For more detail, please open [Markdown Reference](/Markdown-Reference/). | ||
**Typora** use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/), For more details, please open the [Markdown Reference](/Markdown-Reference/). | ||
|
||
To see full markdown Syntax references and extra usage, please check `Help`->`Markdown Reference` in menu bar. | ||
To see full Markdown Syntax references and extra usage, please check `Help`->`Markdown Reference` in the menu bar. | ||
|
||
## Useful Shortcuts | ||
|
||
|
@@ -35,59 +35,59 @@ For more shortcut keys and custom key bindings, you can refer [here](http://supp | |
|
||
### Open Quickly | ||
|
||
The quick open panel can be popped up by pressing <kbd>Command+Shift+O</kbd> (*on macOS*) or <kbd>Ctrl+P</kbd> (*on Windows/Linux*), or click "Open Quickly" from `File` menu. | ||
The quick open panel can be popped up by pressing <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>O</kbd> (*on macOS*), <kbd>Ctrl</kbd> + <kbd>P</kbd> (*on Windows/Linux*) or clicking "Open Quickly" from the `File` menu. | ||
|
||
You could use fuzzy search to find & open files in current folder quickly. | ||
You can use fuzzy search to find & open files in the current folder quickly. | ||
|
||
### Open Folder | ||
|
||
You could select a folder in the open file dialog popup from `File` → `Open` menu to open a folder in Typora. Actually you do not need to open folder explicitly in this way, when you open a file, its parent folder will be automatically loaded, you could check the folder from "Files Sidebar", which will be introduce below. | ||
You can select a folder in the open file dialog popup from `File` → `Open` in the menu to open a folder in Typora. Actually, you do not need to open a folder explicitly in this way as when you open a file its parent folder will be automatically loaded. You could check the folder from the "Files Sidebar", which will be introduced below. | ||
|
||
### Files Sidebar | ||
|
||
User can toggle sidebar from menubar or from titlebar on macOS and from status bar on Windows/Linux. | ||
Users can toggle the sidebar using the menubar or from the titlebar on macOS and from the status bar on Windows/Linux. | ||
|
||
Typora has two types of sidebar: | ||
|
||
- Outline Panel (display *table of contents* of current document) | ||
- Outline Panel (display *table of contents* of the current document) | ||
- File Tree (display loaded folder in tree hierarchy) | ||
- File List (display files in loaded folder as lists) | ||
|
||
In file tree mode, currently only folder and files that are supported by Typora (Markdown file, text file, etc) is displayed. | ||
In file tree mode, currently only folders and files that are supported by Typora (Markdown file, text file, etc) are displayed. | ||
|
||
### Global Search | ||
|
||
You could click the "Search" icon on side panel on macOS or just scroll top on side panel on Windows/Linux version of Typora to show global search input. Or use hotkey <kbd>Command(Ctrl) + Shift + F</kbd> to open global search. | ||
You can click the "Search" icon in the side panel on macOS or just scroll to the top of the side panel in the Windows/Linux version of Typora to show the global search input. Alternatively, use the hotkey <kbd>Command/Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>F</kbd> to open the global search. | ||
|
||
## Outline | ||
|
||
Mouse over the windows toolbar and click the outline icon on the right top of the window can open outline panel. This Panel can be pinned to left side. | ||
Mouse over the windows toolbar and click the outline icon at the top right of the window to open the outline panel. This panel can be pinned to the left side. | ||
|
||
## Word Count | ||
|
||
Mouse over the windows toolbar will make word count visible. "Always show word count" can be set from preference panel. Click it will popup detailed word count tooltip. If a range of text is selected word count for selection will also be displayed on word count tooltip. | ||
Hovering over the windows toolbar with your cursor will also make the word count visible. "Always show word count" can be set from the preference panel. Clicking it will pop up a detailed word count tooltip. If a range of text is selected, the word count for the selection will also be displayed. | ||
|
||
## Copy | ||
|
||
We create typora and want to make it your default markdown editor, thus copy and paste means copy from another app or paste to another app, instead of *copy/paste from/to another markdown editor*. Therefore, by default, `Copy` means `Copy As HTML` ( and `Paste` means `Paste from HTML`). | ||
We created Typora and want to make it your default Markdown editor, thus copy and paste means copy from another app or paste to another app, instead of *copy/paste from/to another Markdown editor*. Therefore, by default, `Copy` means `Copy As HTML` ( and `Paste` means `Paste from HTML`). | ||
|
||
However, after click "**Copy Markdown source by default**", typora will copy selected text in HTML/markdown format (When pasting, rich editors will accept the HTML format, while plain text / code editor will accept the markdown source code format). | ||
However, after clicking "**Copy Markdown source by default**", Typora will copy selected text in HTML/Markdown format. (When pasting, rich editors will accept the HTML format, while plain text / code editors will accept the Markdown source code format). | ||
|
||
To **copy Markdown source code** explicitly, please use shortcut key `shift+cmd+c` or `Copy as Markdown` from menu. To **Copy as HTML Code**, please select `Copy as HTML Code` from menu. | ||
To **copy Markdown source code** explicitly, please use the shortcut key <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>C</kbd> or use `Copy as Markdown` from the menu. To **Copy as HTML Code**, please select `Copy as HTML Code` from the menu. | ||
|
||
## Smart Paste | ||
|
||
**Typora** is able to analyze styles of the text content in your clipboard when pasting. For example, after pasting a `<h1>HEADING</h1>` from some website, typora will keep the 'first level heading’ format instead of paste ‘heading’ as plain text. | ||
**Typora** is able to analyze styles of the text content in your clipboard when pasting. For example, after pasting `<h1>HEADING</h1>` from some HTML, Typora will keep the 'first level heading’ format instead of pasting ‘heading’ as plain text. | ||
|
||
To **paste as markdown source** or plain text, you should use `paste as plain text` or press the shortcut key: `shift+cmd+v`. | ||
To **paste as Markdown source** or plain text, you should use `paste as plain text` or use the shortcut key <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>V</kbd>. | ||
|
||
## Themes | ||
|
||
Please refer to `Help` → `Custom Themes` from menu bar. | ||
Please refer to `Help` → `Custom Themes` from the menu bar. | ||
|
||
## Publish | ||
|
||
Currently Typora only support to export as **PDF** or **HTML**. More data format support as import/export will be integrated in future. | ||
Currently, Typora supports exporting to **PDF**, **HTML**, **HTML (without styles)** and an **Image** format. More formats (like Word, RTF, etc) are supported via [pandoc](https://pandoc.org/). Please visit the [Export](https://support.typora.io/Export/) support page for further information. | ||
|
||
## Command Line Tool | ||
|
||
|
@@ -97,9 +97,9 @@ Please see <https://support.typora.io/Use-Typora-From-Shell-or-cmd/>. | |
|
||
<https://support.typora.io/> | ||
|
||
## And More ? | ||
## And More? | ||
|
||
For more questions or feedbacks, please contact us by: | ||
For more questions or feedback, please contact us by: | ||
|
||
- Home Page: http://typora.io | ||
- Email: <[email protected]> | ||
|
Oops, something went wrong.