Markdown语法说明

1.9k 词

编辑:糖果

11# Guide

这是一篇讲解如何正确使用OpenResty China 的 Markdown 的排版示例,学会这个很有必要,能让你的文章有更佳清晰的排版。

引用文本:Markdown is a text formatting syntax inspired

语法指导

普通内容

这段内容展示了在内容里面一些小的格式,比如:

  • 加粗 - **加粗**

  • 倾斜 - *倾斜*

  • 删除线 - ~~删除线~~

  • Code 标记 - Code 标记

  • 超级链接 - [超级链接](http://github.com)

  • sumory.wu@gmail.com - [sumory.wu@gmail.com](mailto:sumory.wu@gmail.com)

评论文章时提及用户

@sumory … 通过 @ 可以在评论里面提及用户,信息提交以后,被提及的用户将会收到系统通知。以便让他来关注这个帖子或回帖。

表情符号 Emoji

OpenResty China 支持表情符号,你可以用系统默认的 Emoji 符号。
也可以用图片的表情,输入 : 将会出现智能提示。

一些表情例子

😄 😆 😵 😭 😰 😅 😢 😤 😍 😆 ☺️ 😎 😩

👍 👎 💯 👏 🔔 🎁 ❓ 💣 ❤️ ☕ 🌀 🙇 💋 🙏 💩 💦 ❗ 💢

对应字符串表示如下:

:smile: :laughing: :dizzy_face: :sob: :cold_sweat: :sweat_smile:  :cry: :triumph: :heart_eyes:  :satisfied: :relaxed: :sunglasses: :weary:
:+1: :-1: :100: :clap: :bell: :gift: :question: :bomb: :heart: :coffee: :cyclone: :bow: :kiss: :pray: :shit: :sweat_drops: :exclamation: :anger:

更多表情请访问:http://www.emoji-cheat-sheet.com

大标题 - Heading 3

你可以选择使用 H2 至 H6,使用 ##(N) 打头,H1 不能使用,会自动转换成 H2。

NOTE: 别忘了 # 后面需要有空格!

Heading 4

Heading 5
Heading 6

代码块

普通

*emphasize*    **strong**
_emphasize_    __strong__
@a = 1

语法高亮支持

如果在 ``` 后面更随语言名称,可以有语法高亮的效果哦,比如:

演示 Lua 代码高亮
local lor = require("lor.index")
local app = lor()

app:get("/", function(req, res, next)
    res:send("hello world!")
end)

app:run()
演示 Javascript 高亮
(function (L) {
    var _this = null;
    L.Common = L.Common || {};
    _this = L.Common = {
        data: {},
 
        init: function () {
            console.log("init function");
        },

        formatDate: function (now) {
            var year = now.getFullYear();
            var month = now.getMonth() + 1;
            var date = now.getDate();
            var hour = now.getHours();
            var minute = now.getMinutes();
            var second = now.getSeconds();
            if (second < 10) second = "0" + second;
            return year + "-" + month + "-" + date + " " + hour + ":" + minute + ":" + second;
        }
    };
}(APP));
演示 YAML 文件
zh-CN:
  name: 姓名
  age: 年龄

Tip: 语言名称支持下面这些: ruby, python, js, html, erb, css, coffee, bash, json, yml, xml

有序、无序列表

无序列表

  • Ruby

    • Rails
      • ActiveRecord
  • Go

    • Gofmt
    • Revel
  • Node.js

    • Koa
    • Express

有序列表

  1. Node.js

  2. Express

  3. Koa

  4. Sails

  5. Ruby

  6. Rails

  7. Sinatra

  8. Go

表格

如果需要展示数据什么的,可以选择使用表格哦

header 1 header 3
cell 1 cell 2
cell 3 cell 4
cell 5 cell 6

段落

留空白的换行,将会被自动转换成一个段落,会有一定的段落间距,便于阅读。

请注意后面 Markdown 源代码的换行留空情况。

原文