# simpread **Repository Path**: addio/simpread ## Basic Information - **Project Name**: simpread - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-12-31 - **Last Updated**: 2021-08-30 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # simpread ## 简悦 - [github](https://github.com/Kenshin/simpread) - [doc](http://ksria.com/simpread/docs/#/) # Markdown 基本要素 这篇文件意在简要介绍 [GitHub Flavored Markdown 写作](https://guides.github.com/features/mastering-markdown/)。 ## 什么是 Markdown? `Markdown` 是一种文本格式。你可以用它来控制文档的显示。使用 markdown，你可以创建粗体的文字，斜体的文字，添加图片，并且创建列表 等等。基本上来讲，Markdown 就是普通的文字加上 `#` 或者 `*` 等符号。 ## 语法说明 ### 标题 ```markdown # 这是

一级标题 ## 这是

二级标题 ### 这是

三级标题 #### 这是

四级标题 ##### 这是

五级标题 ###### 这是
六级标题 ``` 如果你想要给你的标题添加 `id` 或者 `class`，请在标题最后添加 `{#id .class1 .class2}`。例如： ```markdown # 这个标题拥有 1 个 id {#my_id} # 这个标题有 2 个 classes {.class1 .class2} ``` > 这是一个 MPE 扩展的特性。 ### 强调 ```markdown *这会是 斜体 的文字* _这会是 斜体 的文字_ **这会是 粗体 的文字** __这会是 粗体 的文字__ _你也 **组合** 这些符号_ ~~这个文字将会被横线删除~~ ``` ### 列表 #### 无序列表 ```markdown - Item 1 - Item 2 - Item 2a - Item 2b ``` #### 有序列表 ```markdown 1. Item 1 1. Item 2 1. Item 3 1. Item 3a 1. Item 3b ``` ### 添加图片 ```markdown ![GitHub Logo](/images/logo.png) Format: ![Alt Text](url) ``` ### 链接 ```markdown https://github.com - 自动生成！ [GitHub](https://github.com) ``` ### 引用 ```markdown 正如 Kanye West 所说： > We're living the future so > the present is our past. ``` ### 分割线 ```markdown 如下，三个或者更多的 --- 连字符 --- 星号 --- 下划线 ``` ### 行内代码 ```markdown 我觉得你应该在这里使用 `` 才对。 ``` ### 代码块 你可以在你的代码上面和下面添加 \`\`\` 来表示代码块。 #### 语法高亮 你可以给你的代码块添加任何一种语言的语法高亮 例如，给 ruby 代码添加语法高亮： ```ruby require 'redcarpet' markdown = Redcarpet.new("Hello World!") puts markdown.to_html ``` 会得到下面的效果： ```ruby require 'redcarpet' markdown = Redcarpet.new("Hello World!") puts markdown.to_html ``` #### 代码块 class（MPE 扩展的特性） 你可以给你的代码块设置 `class`。 例如，添加 `class1 class2` 到一个 代码块： ```javascript {.class1 .class} function add(x, y) { return x + y } ``` ##### 代码行数 如果你想要你的代码块显示代码行数，只要添加 `line-numbers` class 就可以了。 例如： ```javascript {.line-numbers} function add(x, y) { return x + y } ``` 将会得到下面的显示效果： ![screen shot 2017-07-14 at 1 20 27 am](https://user-images.githubusercontent.com/1908863/28200587-a8582b0a-6832-11e7-83a7-6c3bb011322f.png) ##### 高亮代码行数 你可以通过添加 `highlight` 属性的方式来高亮代码行数： ````markdown ```javascript {highlight=10} ``` ```javascript {highlight=10-20} ``` ```javascript {highlight=[1-10,15,20-22]} ``` ```` ### 任务列表 ```markdown - [x] @mentions, #refs, [links](), **formatting**, and tags supported - [x] list syntax required (any unordered or ordered list supported) - [x] this is a complete item - [ ] this is an incomplete item ``` ### 表格 ```markdown | First Header | Second Header | | --------------------------- | ---------------------------- | | Content from cell 1 | Content from cell 2 | | Content in the first column | Content in the second column | ``` ## 扩展的语法 ### 表格 > 需要在插件设置中打开 `enableExtendedTableSyntax` 选项来使其工作。 ![screen shot 2017-07-15 at 8 16 45 pm](https://user-images.githubusercontent.com/1908863/28243710-945e3004-699a-11e7-9a5f-d74f6c944c3b.png) ### Emoji & Font-Awesome > 只适用于 `markdown-it parser` 而不适用于 `pandoc parser`。 > 缺省下是启用的。你可以在插件设置里禁用此功能。 ``` :smile: :fa-car: ``` ### 上标 ```markdown 30^th^ ``` ### 下标 ```markdown H~2~O ``` ### 脚注 ```markdown Content [^1] [^1]: Hi! This is a footnote ``` ### 缩略 ```markdown _[HTML]: Hyper Text Markup Language _[W3C]: World Wide Web Consortium The HTML specification is maintained by the W3C. ``` ### 标记 ```markdown ==marked== ``` ### CriticMarkup CriticMarkup 缺省是禁用的，你可以通过插件设置来启动它。 有关 CriticMarkup 的更多信息，请查看 [CriticMarkup 用户指南](https://criticmarkup.com/users-guide.php). 这里有 5 种基本语法： - 添加 `{++ ++}` - 删除 `{-- --}` - 替换 `{~~ ~> ~~}` - 注释 `{>> <<}` - 高亮 `{== ==}{>> <<}` > CriticMarkup 仅可用于 markdown-it parser，不与 pandoc parser 兼容。 ## 参考 - [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) - [Daring Fireball: Markdown Basics](https://daringfireball.net/projects/markdown/basics) [➔ 数学](zh-cn/math.md)