Sublime Text 的 SourceDown 插件

将您的注释脚本转换为 Markdown 文档。可用于博客/论坛帖子、教程、基本的可读性编程/脚本。

注释将被取消注释，代码将被包围/缩进。您的注释将逐字复制，因此如果它们包含有效的 Markdown，它将正确渲染。该软件包支持 Sublime Text 所支持的所有语言（它使用作用域来检测注释）。

安装

1. 安装 Sublime Text
2. 安装插件

- with **Package Control** (recommended): see <https://sublime.wbond.net/docs/usage>, or
 - **manually**: by cloning this repository in your Sublime Text Package directory

功能

source_down 命令将当前视图的内容转换为包含代码片段作为原始文本和注释作为主要文本的 Markdown 文件。

例如

# # This is an example
# 
# This `script` is *awesome*!
# Just run it with
# 
#     > python awesome.py
# 
# And enjoy!

print("awesome") # TODO: add functionality

变为

# This is an example

This `script` is *awesome*!
Just run it with

    > python awesome.py

And enjoy!

```python
print("awesome") 

```

TODO: add functionality

这反过来又可以编译为

这是一个示例

这个 脚本 真棒！只需运行它即可

> python awesome.py

并享受吧！

print("awesome")

待办事项：添加功能

选项

fenced（默认：true）

使用围栏 GFM 语法进行代码片段。如果片段包含反引号，则围栏将扩展到不再模糊其结束位置（参阅 Pandoc）。

ignore_code（默认：false）

这仅处理注释以生成 Markdown 版本。

convert_line_comments（默认："lonely"）

行注释是以标记开头并结束至行尾的注释。此设置可取以下值

• "all"：所有行注释将转换为 Markdown 文本；
• "none"：所有行注释将保留为它们所属的原始代码块中的注释。
• "lonely"：只有“独立”行注释（即占满整行的注释）会被转换。

convert_block_comments（默认：true）

此设置控制是否将块注释（带有起始和结束分隔符的注释）转换为Markdown文本或者将其保留为属于原始代码块中的注释。

keep_comments_beyond_level（默认：2）

缩进级别大于所指示级别的注释将保留为原始代码块中的注释。

deindent_code（默认：false）

如果设置为true，则从代码片段生成的原始代码块将取消缩进。

deindent_comments（默认：true）

如果设置为true，从注释中提取的Markdown文本将被取消缩进。

guess_comments_indent_from_first_line（默认：true）

如果设置为true，缩进级别将考虑一个块注释的第一行的起始位置。例如

a = 0 /* The following line
         will be deindented to level 0 */

将被转换为

```c
a = 0

```

The following line
will be deindented to level 0

extension（默认："md"）

这是与Markdown文件关联的文件扩展名。