Harp Markdown
Markdown 易于编写、易于阅读的格式对于在网络上编写非常有用且流行。
Harp 默认包含普遍有用的预处理器。这意味着你没必要浪费时间在将你的 Markdown 转化成 HTML——每件事都会正常工作。另外,Jade 和 EJS 文件可以把 Markdown 当作局部视图导入,让你可以有效地复用代码。
用法
Harp 的 asset pipeline 很容易使用。所有的处理过程都会自动发生,并不需要进行设置。只需要把你的文件加一个 .md
后缀,Harp 网页服务器会把它当作一个 .html
文件来解析。 有些其他的 Markdown 解析器可能还支持 .markdown
、.mdown
、.txt
或者其他的扩展名。Harp 只会处理 .md
文件。
示例
这个项目在根目录中包含 index.md
和 about.md
文件。
myproject/
|- index.md
+- about.md
index.md
以及 about.md
都会被当作 .html
文件进行解析。因此,对一下路径的访问都会工作:
/
/index
/index.html
/about
/about.html
运行 Harp 的 编译步骤 也会把文件当作 index.html
和 about.html
导入进来。
GitHub 最爱的 Markdown
Harp 还支持 GitHub Flavoured Markdown 补充语法。(这不包括 Github 专用功能,例如任务列表和 @mentions
等等。)这可以让你写一个围起来的代码块:
```
function test() {
console.log("Hello, world");
}
```
您还可以指定代码语言:
```javascript
function test() {
console.log("Hello, world");
}
```
function test() {
console.log("Hello, world");
}
Harp 将代码块作为 HTML 提供:
<pre><code class="language-javascript">function test() {
console.log("Hello, world");
}</code></pre>
在language-
类名遵循W3C和WHATWG指定类型的代码约定。这还允许你使用客户端语法高亮库(如Prism )对其进行样式设置。
管理文件扩展名
你可能会发现自己想要创建另一个基于标记的文件,而不是.html
使用 Markdown。没问题:只需.md
添加你选择的扩展名即可。例如,feed.xml.md
将由 Harpfeed.xml
代替。
更多建议: