跳转到主要内容

Python Markdown的aafigure扩展

项目描述

logo

Markdown aafigure

这是一个Python Markdown的扩展,使用aafigure渲染图表。

项目/仓库

MIT License Supported Python Versions CalVer v202405.1012 PyPI Version PyPI Downloads

代码质量/CI

GitHub CI Status GitLab CI Status Type Checked with mypy Code Coverage Code Style: sjfmt

名称 角色
Manuel Barkhau (mbarkhau@gmail.com) 作者/维护者 2018-05 -

INFO:您可能希望考虑使用markdown-svgbob扩展而不是这个。svgbob有一个在线编辑器,并支持更广泛的形状和图表。其主要缺点是“仅”在Windows、Linux和Mac上的x86_64上内置支持,而aafigure是纯Python,支持所有地方。

安装

$ pip install markdown-aafigure
$ pip install Pillow    # only if you want to render as png

使用

在您的markdown文本中,您可以定义以下块

```aafigure
      +-----+   ^
      |     |   |
  --->+     +---o--->
      |     |   |
      +-----+   V
```

可以为单个图表设置参数。 可用参数

```aafigure {"foreground": "#ff0000"}
      +-----+   ^
      |     |   |
  --->+     +---o--->
      |     |   |
      +-----+   V
```

开发/测试

$ git clone https://gitlab.com/mbarkhau/markdown_aafigure
$ cd markdown_aafigure
$ make install
$ make lint mypy test

MkDocs集成

在您的mkdocs.yml中,将此添加到markdown_extensions。

markdown_extensions:
  - markdown_aafigure:
      tag_type: inline_svg

有效的 tag_type 选项为 inline_svg(默认),img_utf8_svgimg_base64_svgimg_base64_png

https://gitlab.com/mbarkhau/markdown_aafigure 的变更日志

v202104.1011

  • 添加了对带有额外反引号的块的支持

v202103.1010

v202001.0009

  • 修复:忽略关闭栅栏后的尾随空白

v202001.0008

  • 修复:当 markdown 有多个图表时,图像替换错误

v201907.0006

  • 修复:对于 py<35 不需要 typing 包

v201904.0005

  • 添加:支持内联 svg
  • 添加:添加 tag_type 选项以更好地控制嵌入
  • 弃用:format 参数

v201904.0004

  • 添加:支持格式:png 扩展配置(需要 Pillow)
  • 修复:使用 base64 编码图像 uri

v201904.0003

  • 修复 #3:在图像数据 uri 中转义 xml
  • 修复:清理调试输出
  • 更改:迁移到 gitlab.com/mbarkhau/markdown-aafigure
  • 更改:切换到 pycalver
  • 更改:项目打包更新

0.2.0 (2018-05-28)

  • 初始发布

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分发

markdown_aafigure-202405.1012.tar.gz (13.7 kB 查看哈希值

上传时间

构建分发

markdown_aafigure-202405.1012-py2.py3-none-any.whl (8.4 kB 查看哈希值

上传时间 Python 2 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面