如何为开发者博客制作更好的Markdown

1 投票
3 回答
591 浏览
提问于 2025-04-15 14:56

我正在重建我的博客,地址是 http://www.elmalabarista.com/blog/。在之前的版本中,我使用了markdown,但现在我才明白为什么我几乎没有代码示例。用markdown写代码示例真的很麻烦。

我试着在里面放一些Python代码,但我无法让markdown把它标记为代码!主要的问题是,markdown对代码的语法要求很严格,特别是空格的使用。尽管我使用的是wmd作为编辑器(在StackOverflow上是怎么工作的我还搞不清楚),但它总是无法正确对齐文本,所以代码就无法正常显示。这就是问题所在:

我放了一些简单的代码:

:::python
def hello():
   pass

但问题是我有这样的代码:

:::python
def hello():
pass

或者

:::python
def hello():
pass

(是的,两个代码块都是格式化过的,但你看?还是不行)。只要有一点小错误,比如使用了制表符、空格太多或太少,都会导致问题。而且如果代码很长,出错的机会就更大了。

所以,有没有什么简单的方法可以做到:

### 我的文章

  1. 我的列表项一
  2. 我的列表项二

:::python
def x (a, b):
return a * b

这样就能正确转换,并且再也不用担心这些小问题了???

顺便说一下,我正在使用pygments和python markdown。

3 个回答

1

你需要把代码缩进超过4个空格(顺便说一下,你有没有注意到在StackOverflow上,如果你加了4个空格,它会被识别为代码),下面这个就是缩进了4个空格的代码:

:::python
def hello():
    pass
1

我一直在使用google-code-prettify,效果还不错。

使用方法

把代码片段放在<pre class="prettyprint">...</pre>或者<code class="prettyprint">...</code>里,它会自动帮你美化代码。

3

可以考虑使用 reStructuredText —— 这是Python的标准轻量级标记语言,通常用来写文档字符串和嵌入式文档。它使用起来很简单,但功能也很强大。如果我没记错的话,Python的核心库和Django框架都是用它的。

撰写回答