跳转到主要内容

Python Markdown 的 svgbob 扩展

项目描述

logo

markdown-svgbob

这是一个为 Python Markdown 编写的扩展,它使用 svgbob 渲染图表。

您可以使用 Svgbob EditorAsciiGrid Editor 尝试它。

项目/仓库

MIT License Supported Python Versions CalVer v202406.1023 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) 作者/维护者 2019-04 -

安装

$ pip install markdown-svgbob

此软件包包含以下二进制文件

  • svgbob_0.5.5_x86_64-Darwin
  • svgbob_0.5.5_x86_64-Linux
  • svgbob_0.5.5_x86_64-Windows.exe

如果您使用的是其他平台,或者想使用更新的 svgbob_cli 版本,您需要安装rust,然后通过cargo安装svgbob。

$ curl https://sh.rustup.rs -sSf | sh   # see https://rustup.rs/
$ cargo install svgbob_cli

如果svgbob已安装,此扩展将始终使用安装的版本。

用法

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

```bob
     .---.
    /-o-/--
 .-/ / /->
( *  \/
 '-.  \
    \ /
     '
```

信息字符串 bob 被选择以匹配 spongedown

开发/测试

$ git clone https://github.com/mbarkhau/markdown-svgbob
$ cd markdown-svgbob
$ make conda
$ make lint mypy test

MkDocs集成

在您的 mkdocs.yml 中,将以下内容添加到 markdown_extensions。

markdown_extensions:
  - markdown_svgbob:
      tag_type: inline_svg
      bg_color: white
      fg_color: black
      min_char_width: 80

有效的 tag_type 选项有 inline_svg(默认值),img_utf8_svgimg_base64_svg

选项 min_char_width 允许您创建统一比例的图表。

https://github.com/mbarkhau/markdown-svgbob 的变更日志

v202406.1023

  • 修复要求指定器

v202112.1022

  • 升级 svgbob 二进制文件到 0.5.5

v202109.1020

  • 升级 Linux 版本的 svgbob 到 0.6.2
  • 使用 lib3to6==202108.1048 打包

我无法获取 windows 或 macos 的新二进制文件,欢迎为 svgbob 贡献。 https://github.com/ivanceras/svgbob/issues/35

v202107.1018

  • 修复:由于 'toc' 扩展导致的误报警告。

v202104.1016

  • 修复:修复 Popen 关闭文件描述符
  • 添加对带有额外反引号的块的支持

v202103.1015

  • 修复:由于 Markdown>=3.3 支持破坏了 Markdown in HTML 而导致的问题。

v202006.0015

  • 修复:在某些情况下 bg_color 未更新

v202001.0013-beta

  • 修复 #2:忽略围栏后面的尾随空格。

v202001.0012-beta

  • 添加:添加 min_char_width 选项。允许文档中的图表具有统一的比例。

v202001.0011-beta

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

v202001.0009-beta

  • 修复:围栏解析错误

v201907.0008-beta

  • 修复:使用 PEP 508 环境标记以避免始终安装 typing 包。修复 gitlab#1

v201905.0007-beta

  • 添加:添加 bg_colorfg_color 选项

v201905.0006-beta

  • 修复:更好的错误报告
  • 修复:清理临时目录

v201904.0004-beta

  • 初始版本

项目详情


下载文件

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

源分布

markdown_svgbob-202406.1023.tar.gz (2.6 MB 查看哈希值

上传时间

构建分布

markdown_svgbob-202406.1023-py2.py3-none-any.whl (2.6 MB 查看哈希值

上传于 Python 2 Python 3

由以下组织支持