前端:给你的Markdown文章添加代码高亮及行号

文 / 秦未

这篇文章是给不使用Pygments的童鞋写的,前端的插件实在太多,除了学习外,在快速开发时重复造轮子没有必要,现在就教大家快速实现代码块的代码高亮及行号。

先贴效果:

前端:给你的Markdown文章添加代码高亮及行号_第1张图片
Python代码块

要使用的插件:

highlightj.js 代码高亮
highlightjs-line-numbers.js 代码行号


highlightj.js 优势:
  • 支持174种语言和拥有77种款式
  • 自动语言检测
  • 多语言代码突出显示
  • 可用于node.js
  • 与任何标记一起使用
  • 兼容任何js框架

一、使用方法:

highlightj 样式文件地址:http://www.bootcdn.cn/highlight.js/

自己挑选自己喜欢的就好。

1.在需要渲染的页面引入样式文件:

2.引入Js文件并添加调用命令:


3.添加行号插件:


---以下部分为2017.06.09新增内容---

最后涉及一点关于Markdown解析模块的优化方案:

经过了解,目前最好的Markdown解析模块是Mistune,它相对于Markdown模块,文本渲染速度提升了十倍左右,而且使用也非常简单,我们没什么理由拒绝使用它。

关于使用教程,GitHub已经介绍得很清楚了,但是由于是英文的,我就粗略的翻译一下,给大家介绍一下使用方法。


安装:

pip install mistune

或者用cython编译它,显然速度更快:

pip install cython mistune

基础的使用:

import mistune

mistune.markdown('I am using **mistune markdown parser**')
# 输出结果: 

I am using mistune markdown parser

当然,官方推荐使用下面这种方法,能提高性能:

import mistune

markdown = mistune.Markdown()
markdown('I am using **mistune markdown parser**')

Mistune默认启用了所有功能, 你不必配置任何东西。 但是你可以选择更改解析器的一些配置。

renderer = mistune.Renderer(escape=True, hard_wrap=True)
# 实例化mistune
markdown = mistune.Markdown(renderer=renderer)
markdown(text)
# text为要渲染的文本内容

说明:

  • escape:如果设置为False,则所有原始HTML标签都不会被转义。
  • hard_wrap:如果设置为True,它将具有GFM换行符功能。 所有新行将被替换为
    标记。
  • use_xhtml:如果设置为True,则所有标签都将位于xhtml中,例如:
    标签。
  • parse_block_html:仅在块级别HTML中解析文本。
  • parse_inline_html:仅在内联级HTML中解析文本。

使用默认渲染器时,可以使用以下快捷方式之一:

# 第一种方式
mistune.markdown(text, escape=True, hard_wrap=True)

# 第二种方式
markdown = mistune.Markdown(escape=True, hard_wrap=True)
markdown(text)

更多内容,请查阅官方文档:http://mistune.readthedocs.io/en/latest/


你可能感兴趣的:(前端:给你的Markdown文章添加代码高亮及行号)