YiFeiShu - Editor

Preview

[!image]

#! YiFeiShu - `Kude`

##! About `Kude`

### 1. What is a `Kude`?
`Kude` is a markup language in plain text format. With a simple markup syntax, it is possible to give a certain format to ordinary textual content.

### 2. Why choose `Kude` over `Markdown`?
`Kude`'s rules follow a single principle, `Markdown`'s rules are too liberal (e.g. `- + *` symbols can all be used for unordered lists, whereas `Kude` only allows `+` symbols), and the convention of using 3 spaces at the end of a `Markdown` line for a line feed is abandoned.

For good advice on using `Kude`, please send an email directly to [@email hu@yifeishu.com] and discuss the improvement with the author. The `Kude` parser uses the `MIT` license, which is completely free and open, which is [@kude the link].

### 3. What is `yifeishu.com`?
`yifeishu.com` is an online document sharing platform based on `Kude`, which supports features such as "generate online pages", "save PDF documents", "download `Kude` source files", "subscribe to article updates by email", etc.

In `yifeishu.com`, all your articles are *non-public by default*, you can make your articles public or hide your email address when readers read any of your articles, just visit `https://yifeishu.com/your_email` page and clicking the `Public | Private` button.

You can click directly on [@editor yifeishu.com] to start the experience immediately.

---

##! `Kude` syntax

### 1. Code block
```
function test(arg) {
    ...
    // Use ``` symbols to indicate the beginning and end of block-level code, noting that ``` must occupy a separate line.
}
```

### 2. Title
Line headers use 1 to 6 consecutive `#` symbols to indicate 1 to 6 level headings, with headings aligned left by default. To center the display, follow the `!` symbol is sufficient.
For example:
```
# I title
##! Middle Grade Title
### Level III title
####! Middle Grade 4 title
##### Level 5 title
######! Middle Grade 6 title
```

### 3. Text style
The following are currently supported:
1.^highlight^ 2._underline_ 3.-strikethrough- 4.[@url link] 5./italics/ 6.*bold* 7.`inline code`
There are a total of 7 style rules.
For example:
```
^highlight^          _underline_          -strikethrough-          [@url link]
/italics/          *bold*          `inline code`
```

If you need to enter `^` `_` `-` `/` `*` `\``6 control characters, use the \ character before it.
For example:
```
^highlight^          _underline_          -strikethrough-
/italics/          *bold*          `inline code`
```

### 4. Horizontal line
Use the continuous `-` three characters to display a horizontal split line.
For example:
```
---
// Note --- must have an exclusive line
```

### 5. External links & Images & Website links
To use images or links in `Kude`, the `URL` must be placed at the end of the document and must not be followed by characters other than line breaks.

Define `URL`, for example:
```
... Above is the content of the document, with the URL information placed at the end of the text.
Fill in the URL ID at the ① for reference to pictures or links in the document.
Enter the URL address at ②.
Fill in the URL prompt information at the ③ place, which can be omitted.

[①](② ③)
[url_name](https://yifeishu.com/ online article)
[image_name](https://yifeishu.com/images/h.png)
```

Enter an image, for example:
```
The image quote must be exclusive to one line.

[!④ ⑤]
[!image_name image loading failed]

Enter the URL ID set at ① at ④.
Fill in the picture description at ⑤, and the description information will be displayed if the picture load fails, and can be omitted.
```

Enter a web address, for example:
```
Link references can be placed in other text lines.

[@⑥ ⑦]
[@url_name Click here]

Enter the URL ID set at ① at ⑥.
⑦ Fill in the link prompt text at the seventh place, which may be omitted.
```
`⑤⑦` has a higher priority when `③⑤⑦` is present at the same time.

### 6. Ordered list & Unordered list
1. The number is immediately followed by `.` Symbols indicate ordered list items, with one list item occupying a single line.
2. Note that a blank character is required before the content of the list item to distinguish the prefix from the content.
+ The `+` symbol indicates an unordered list item, with one list item occupying a single line.
+ Note that a blank character is required before the content of the list item to distinguish the prefix from the content.

For Example:
```
1. Ordered lists
+ unordered list
```

### 7. Table
The table header uses multiple numbers to indicate how many columns of data are available, separated by `|` symbols.

[kude](https://www.npmjs.com/package/kude)
[editor](https://yifeishu.com/view/editor)
[email](mailto:hu@yifeishu.com?subject=Kude%20Feedback)
[image](https://yifeishu.com/images/logo/favicon_60.png logo)

Try dragging a "KUDE" here or clicking here.

Edit