使用Python来开发Markdown脚本扩展的实例分享

关于Markdown

在刚才的导语里提到,Markdown 是一种用来写作的轻量级「标记语言」,它用简洁的语法代替排版,而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字,用「标记」语法,来代替常见的排版格式。例如此文从内容到格式,甚至插图,键盘就可以通通搞定了。目前来看,支持 Markdown 语法的编辑器有很多,包括很多网站(例如简书)也支持了 Markdown 的文字录入。Markdown 从写作到完成,导出格式随心所欲,你可以导出 HTML 格式的文件用来网站发布,也可以十分方便的导出 PDF 格式,这种格式写出的简历更能得到 HR 的好感。甚至可以利用 CloudApp 这种云服务工具直接上传至网页用来分享你的文章,全球最大的轻博客平台 Tumblr,也支持使用 Mou 这类 Markdown 工具进行编辑并直接上传。

python的markdown扩展开发
近期使用python的markdown写了一个文档小程序,由于需要用到一些额外的功能,所以就对markdown进行了一些简单的扩展,进而记录下编写的模板。直接贴代码:

#encoding=utf-8
##预处理器
from markdown.preprocessors import Preprocessor
class CodePreprocessor(Preprocessor):
  def run(self, lines):
    new_lines = []
    flag_in = False
    block = []
    for line in lines:
      if line[:3]=='!!!':
        flag_in = True
        block.append('<pre class="brush: %s;">' % line[3:].strip())
      elif flag_in:
        if line.strip() and line[0]=='!':
          block.append(line[1:])
        else:
          flag_in = False
          block.append('</pre>')
          block.append(line)
          new_lines.extend(block)
          block = []
      else:
        new_lines.append(line)
    if not new_lines and block:
      new_lines = block
    return new_lines 

##后置处理器
from markdown.postprocessors import Postprocessor
class CodePostprocessor(Postprocessor):
  def run(self, text):
    t_list = []
    for line in text.split('\n'):
      if line[:5]=='<p>!<':
        line = line.lstrip('<p>').replace('</p>', '')[1:]
      t_list.append(line)
    return '\n'.join(t_list)   

##扩展主体类
from markdown.extensions import Extension
from markdown.util import etree
class CodeExtension(Extension):
  def __init__(self, configs={}):
    self.config = configs 

  def extendMarkdown(self, md, md_globals):
    ##注册扩展,用于markdown.reset时扩展同时reset
    md.registerExtension(self)   

    ##设置Preprocessor
    codepreprocessor = CodePreprocessor()
    #print md.preprocessors.keys()
    md.preprocessors.add('codepreprocessor', codepreprocessor, '<normalize_whitespace') 

    ##设置Postprocessor
    codepostprocessor = CodePostprocessor()
    #print md.postprocessors.keys()
    md.postprocessors.add('codepostprocessor', codepostprocessor, '>unescape') 

    ##print md_globals  ##markdown全局变量

关于markdown扩展的深入内容,可以查看官方文档,不过没有例子,只是手册而已。但大体能知道有哪些内容组成,在结合上面的文件结构都是可以写出来的。下面是调用的代码:

#encoding=utf-8
import markdown
import markdowncode 

text = '''''
!!!python
!
!def foo(): 

###title
''' 

configs = {} 

myext = markdowncode.CodeExtension(configs=configs)
md = markdown.markdown(text, extensions=[myext])
print md

主要扩展了2个功能:
一个是把形如:

!!!python
!
!def foo():
! return 'foo'

转换成:

<pre class="brush: python;"> 

def foo():
 return 'foo'
</pre>

(0)

相关推荐

  • 玩转markdown 分享几个需要用到的工具

    [引自ideras.me的博客]前言 随着wordpress和静态网站的流行,markdown被用的越来越多. markdown是一个面向写作的语法引擎,markdown的最终目的都是解析成html用于网页浏览,所以它兼容html语法,即你可以在 markdown文档中使用原生的html标签. markdown解析器 开发静态网站生成器的时候都会采用一种叫front matter的格式进行网站内容写在类似下面的格式 --- 2.title: 玩转markdown,你需要用到这几个工具 3.dat

  • python 自动化将markdown文件转成html文件的方法

    一.背景 我们项目开发人员写的文档都是markdown文件.对于其它组的同学要进行阅读不是很方便.每次编辑完markdown文件,我都是用软件将md文件转成html文件.刚开始转的时候,还没啥,转得次数多了,就觉得不能继续这样下去了.作为一名开发人员,还是让机器去做这些琐碎的事情吧.故写了两个脚本将md文件转成html文件,并将其放置在web服务器下,方便其他人员阅读. 主要有两个脚本和一个定时任务: •一个python脚本,主要将md文件转成html文件: •一个shell脚本,主要用于管理逻

  • 献给写作者的 Markdown 新手指南

    作为一款「写作软件」在诞生之初就支持了 Markdown,Markdown 是一种「电子邮件」风格的「标记语言」,我们强烈推荐所有写作者学习和掌握该语言.为什么?可以参考: 『为什么作家应该用 Markdown 保存自己的文稿』. 『Markdown写作浅谈』 在此,我们总结 Markdown 的优点如下: 纯文本,所以兼容性极强,可以用所有文本编辑器打开. 让你专注于文字而不是排版. 格式转换方便,Markdown 的文本你可以轻松转换为 html.电子书等. Markdown 的标记语法有极

  • Markdown语法备忘

    Markdown编辑器 Windows:   1. MarkdownPad   2. MarkPad Mac:   *Mou Linux:   * ReText Markdown语法 1.标题 复制代码 代码如下: # H1 <一级标题> ## H2<二级标题> 依次类推,直到 ###### H6<六级标题> 注意:#号和文字之间要有一个空格 2.文字格式 复制代码 代码如下: **文字粗体格式** --->在要加粗的文字左右各加两个*(星号) *文字斜体格式*-

  • 如何使用Gitblog和Markdown建自己的博客

    下面给大家分享下如何使用Gitblog和Markdown建自己的博客,如何大家拥有服务器或者云平台提供的云主机,我推荐大家使用Linux+ Nginx 来运行Gitblog,如果大家目前只有Apache环境也可以. 域名解析 将你准备好的域名解析到你的主机IP,推荐使用 dnspod 来管理和监控你的域名,具体的使用方法参考dnspod官方说明文档,非常简单. Nginx+PHP运行环境 首先安装好你的Nginx和PHP环境,PHP版本要求5.3以上.如果你没有安装过,可Google搜索相关教程

  • 在Ruby on Rails中使用Markdown的方法

    实现 Markdown 语法和代码语法高亮分别是用的 Redcarpet 和 pygments.rb 两个 Gem: https://github.com/vmg/redcarpet     https://github.com/tmm1/pygments.rb     https://github.com/richleland/pygments-css     http://pygments.org/docs/lexers/ 在/Gemfile中添加如下两行: gem 'redcarpet'

  • markdown简介和语法介绍

    一.前言 之前有了解过markdown,但一直没实际使用,今天试用了下,感觉很爽,推荐给大家,特别是在编写规范.接口文档等方面非常适合,因为其简单易用也有很多人用来写网络小说. 二.介绍 Markdown 的目标是实现易读易写,可以直接在问编辑器书写和保存,除本身具有非常好的可读写外,还可以生存格式非常好看的html代码发布在互联网中. 如链接:我们,其书写格式为: [我们](http://www.jb51.net/) Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类

  • Markdown与Bootstrap相结合实现图片自适应属性

    先给大家说下Markdown的基本概念及优点 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式. Markdown 是一种轻量级的标记语言,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被标记.语言所迷惑,Markdown 的语法十分简单.常用的标记符号也不超过十个,这种相对于更为复杂的 HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永

  • 可能是最通俗的一篇介绍markdown的文章

    这些日子一直在简书上使用markdown写作,已经渐渐的痴迷于这种简洁纯粹的写作方式了.不过就我逐渐入门markdown的写作过程来看,目前我看到的各种介绍markdown写作方式的文章都还略显"极客",对于大多数像我一样没有基础的普通人来说,可能内容上的可接受性没有那么强. 于是诞生了写这篇文章的初衷,让更多普通的人理解并爱上这种写作方式.所以全文应该不会出现什么生僻的词汇,大家可以放心的看下去.(好吧其实原因是那些生僻词汇我也不懂啊哈哈) markdown是什么? markdown

  • Markdown+Bootstrap图片自适应属性详解

    Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,Markdown 的语法十分简单.常用的标记符号也不超过十个,这种相对于更为复杂的 HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永逸的效果. 使用 Markdown 的优点 1.专注你的文字内容而不是排版样式,安心写作. 2.轻松的导出 HTML.PDF 和本身的 .md 文件.

  • js验证手机号码

    闲来没事,写了一个小例子,欢迎大家多提宝贵建议~~~ 下面讲一下手机号码的特征:以1开头,第二位是3,5,7,8,9中的一位,从第三位开始是任意数字,一共有11位 <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>手机号码验证</title> </head> <body> Tel:<input type="

随机推荐