mdv - Linux终端下的 Markdown 文档查看器
2019/01/17 19:21:05 来源:Linux公社 作者:醉落红尘

现在,Markdown 差不多已经成为技术文档的标准。它可以实现技术文档的快捷写作,以及输出发布。同样都是标记语言,但Markdown 文档相比HTML更加简单。一是体现在标记符的数量上,二是体现在标记符的书写上。HTML标记符号非常多,并且需要标记内容的开始和结束位置,而Markdown只有四个基本的标记符号,只要在开始位置标记即可。

当我们需要让文档看起来层次分明,但又不依赖于word这样的编辑工具来书写、排版和读取时,Markdown的易写易读优势就非常突出了。并且在我使用一段时间以后,发现使用Markdown非常有助于帮助作者在写作时整理自己的逻辑思路和段落层次。

同HTML一样,你可以使用任何一款纯文本编辑工具来编辑和读取包含Markdown格式的文本,但只有在一些特别的工具或网站下,才能呈现出渲染后的格式。同时Markdown也可以使用HTML来添加格式和排版,这意味着,你即可以使用标准的Markdown语法,也可以在其中嵌入HTML标记,但也只能对应其中的一小部分。

但当您远程编辑多个md文件时,例如在较大的mkdocs项目中,编辑终端和查看浏览器之间的上下文切换可能会对效率产生一些影响。 有时也没有浏览器,例如通过安全网关在机器上跳跃提供一组固定的应用程序。 此外,通过使用颜色,通常可以显着提高阅读效率和便利性。 最后,对cli应用程序使用这样的东西可能会改善用户输出,例如 帮助文本。

这就是mdv,终端的基于Python的Markdown查看器可能是一个不错的选择。

mdv - Linux终端下的 Markdown 文档查看器

mdv 在终端下渲染出 Markdown 文档的样式,包含多个主题、支持表格、源代码高亮显示、文件更改监视等功能。

安装 mdv

要在你的系统上安装 mdv,可以执行以下指令:

linuxidc@linuxidc:~$ sudo apt install python-pip

mdv - Linux终端下的 Markdown 文档查看器

linuxidc@linuxidc:~$ pip install mdv

mdv - Linux终端下的 Markdown 文档查看器

linuxidc@linuxidc:~/桌面/Linux公社$ pip install setuptools

mdv - Linux终端下的 Markdown 文档查看器

linuxidc@linuxidc:~/桌面/Linux公社$ sudo ./setup.py install

mdv - Linux终端下的 Markdown 文档查看器

去掉所有ansi(没有颜色)

linuxidc@linuxidc:~/www.linuxidc.com$ mdv -A linuxidc.com.md

打印html版本

mdv -H linuxidc.com.md

mdv - Linux终端下的 Markdown 文档查看器

markdown使用样例:

linuxidc@linuxidc:~/www.linuxidc.com$ mdv
Using sample markdown:
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
```python
""" Doc String """
class Foo:
    bar = 'baz'
   
```

| Tables        | Fmt |
| -- | -- |
| !!! hint: wrapped | 0.1 **strong** |
   
!!! note: title
    this is a Note

----
!!! question: You like this theme?
Styling Result

Header 1

 Header 2

  Header 3

  Header 4

    Header 5

    Header 6
  <
  ───────────────  ──────────
  Tables          Fmt
  ┃ Hint: wrapped  0.1 strong
  ───────────────  ──────────


  ┃ Note: title
  ┃    this is a Note

 

◈────────────────────────────────◈

 

  ┃ Question: You like this theme?

mdv 的源码位于 GitHub,在那可以了解有关它的更多信息。 

Linux公社的RSS地址https://www.linuxidc.com/rssFeed.aspx

本文永久更新链接地址https://www.linuxidc.com/Linux/2019-01/156421.htm


5

本栏最新