演示文章

作者 huhamhire,暂无评论,2015年6月7日 14:42 无主题

简介

本框架是一套以 reStructuredText 为基础文本标记语言实现的博客系统,兼容 reStructuredText 的主要语法特性,用户可通过书写 reStructuredText 的方式创建博客文章,并实现相关排版功能。本博客系统后台基于 Django 实现。

reStructuredText 是一种轻量级的文本标记语言,名称含义为“重新构建的文本”,也被简称为:RST 或 reST,为 Python 中 Docutils 项目的一部分。其一般保存的文件以.rst为后缀。在必要的时候, .rst 文件可以被转化成 PDF 或者 HTML 格式,也可以用 Sphinx 转化为 LaTeX, man 等格式,现在被广泛的用于程序的文档撰写。

组件示例

段落

段落是博客中最为基础的组件,在 reStructuredText 中使用以空行分割的文本块即可创建段落,段落的显示效果如下:

庄子(约前369年—前286年),庄氏,名周,字子休(一说子沐),楚庄王之后。战国时期宋国蒙(今安徽亳州蒙城人)人。著名的思想家、哲学家、文学家,是道家学派的代表人物,老子哲学思想的继承者和发展者,先秦庄子学派的创始人。他的学说涵盖着当时社会生活的方方面面,但根本精神还是皈依于老子的哲学。后世将他与老子并称为“老庄”,他们的哲学为“老庄哲学”。

庄子曾作过漆园吏,生活贫穷困顿,却鄙弃荣华富贵、权势名利,力图在乱世保持独立的人格,追求逍遥无恃的精神自由。对于庄子在中国文学史和思想史上的重要贡献,封建帝王尤为重视,在唐开元二十五年庄子被诏号为“南华真人”,后人即称《庄子》为《南华经》。其文章具有浓厚的浪漫色彩,对后世文学有很大影响。庄子的思想包含着朴素辩证法因素,主要思想是“天道无为”。

公式

使用 math 指令可在文中插入数学公式,公式部分兼容 LaTeX 公式语法,并以 Unicode 字符组成的串行形式在页面中显示:

  • 高斯定理:

    SDdS = VρdV.

  • 磁场中的高斯定理:

    SBdS = 0.

  • 法拉第定律:

    LEdl =  − S(B)/(t)dS.

  • 薛定谔方程:

    (2)/(2m)2Ψ( r, t) + V(r)Ψ(r, t) = i()/(t)Ψ(r, t).

代码块

技术性博客少不了代码块组件,Python 的 docutils 原生提供了语法高亮的支持,官方号称支持 300+ 种不同的代码语言。基于此,本框架原生提供了代码块组件,使用 code 指令即可在正文插入代码块:


1 int main(int argc, char ** argv)
2 {
3     /* Print a string "Hello World!" */
4     printf("Hello world!\n");
5     return 0;
6 }

图片

通过 image 指令可在文中插入图片。当前文中图片采用居中显示,且在定义了 width 属性时支持响应式特性。除此以外,使用 reStructuredText 的 figure 指令可以创建带描述的图片贴入文章内容中。效果如下:

图片标题

图片标题

图片标题下方还可以提供额外的段落文本描述,以方便对图片展示内容进行更为详细的说明。

表格

reStructuredText 中通过“文字图”(ASCII Art) 的形式创建的表格同样可以得到良好的展现。可以根据实际需要,在文章中通过 Simple tableGrid table 的方法创建各类表格。

# First Name Last Name Username
1 Mark Otto @mdo
2 Jacob Thornton @fat
3 Larry the Bird @twitter

文本引用

通过 epigraph 指令可以在内容中插入文本引用内容,用于着重显示他人提供的观点或其他名人名言。

道可道,非常道。名可名,非常名。无名天地之始;有名万物之母。

—《道德经》

提示框

提示框组件通过对文本内容展现样式的加重,可以向读者文章提供重要信息。reStructuredText 中原生提供的 9 种提示都可以得到支持,分别是 attention, caution, danger, error, hint, important, note, tip 以及 warning。另外,本框架中还支持通过 .. admonition:: success 指令来生成一种额外的提示框样式。提示框组件的展现效果如下:

Well done! You successfully read this important alert message.
Heads up! This alert needs your attention, but it's not super important.
Warning! Better check yourself, you're not looking too good.
Oh snap! Change a few things up and try submitting again.
登录后进行评论