Draft.js导出器 🐍 - Markdown版本

将Draft.js的富文本从原始ContentState转换为Markdown的库，基于Draft.js导出器。

🚧 这是一个具有有限Markdown支持的实验性导出器，请谨慎使用。

使用方法

此包是Draft.js导出器的Markdown导出配置。具体来说，它提供

• 一个Markdown友好的导出引擎，并回退到HTML标签。
• 基本的Markdown格式化配置。

首先安装此包

pip install draftjs_exporter_markdown

然后，将Draft.js内容转换为Markdown

在Python中

from draftjs_exporter.html import HTML
from draftjs_exporter_markdown import BLOCK_MAP, ENGINE, ENTITY_DECORATORS, STYLE_MAP

# Initialise the exporter.
exporter = HTML({
    # Those configurations are overridable like for draftjs_exporter.
    'block_map': BLOCK_MAP,
    'style_map': STYLE_MAP,
    'entity_decorators': ENTITY_DECORATORS,
    'engine': ENGINE,
})

markdown = exporter.render({
    'entityMap': {},
    'blocks': [{
        'key': '6mgfh',
        'text': 'Hello, world!',
        'type': 'unstyled',
        'depth': 0,
        'inlineStyleRanges': [],
        'entityRanges': []
    }]
})

print(markdown)

您还可以通过下载此存储库并使用python example.py来运行示例。

配置

请参阅Draft.js导出器配置文档。

支持的Markdown格式化

内置配置提供了对以下内容的支持

• 内联样式：粗体、斜体、删除线、代码
• 块：段落、标题级别、项目符号和编号列表、代码块、引用块
• 图片、链接和水平线

与主Draft.js导出器相反

• 不支持嵌套/重叠样式。
• 所有内容都没有转义（对于Markdown，HTML转义是不必要的，也没有Markdown转义）。

开发

需求： virtualenv、pyenv、twine

git clone git@github.com:thibaudcolas/draftjs_exporter_markdown.git
cd draftjs_exporter_markdown/

# Install dependencies
nvm install
npm install
# For tests and development in watch mode.
npm install -g nodemon

# Install the Python environment.
virtualenv .venv
source ./.venv/bin/activate
make init

# Install required Python versions
pyenv install --skip-existing 3.6.3
# Make required Python versions available globally.
pyenv global system 3.6.3

# Run the built-in example.
make dev

发布

使用 make release，它使用 standard-version 生成CHANGELOG并根据自上次发布以来的提交来决定版本升级。

致谢

查看完整的贡献者列表。受MIT许可。