跳转到主要内容

自动生成markdown徽章。

项目描述

auto-markdown-badges

pre-commit.ci status test workflow codeql-analysis workflow codecov PyPI version License PyPI - Python Version PyPI version

自动生成markdown徽章。 🧙🖼

markdown-badges 启发,我希望有一个工具可以自动为我创建徽章。

🚀 开始使用

要从PyPI安装它,请运行

pip install auto-markdown-badges

然后只需这样调用即可

Usage: auto-markdown-badges generate [OPTIONS] INPUT_FILE

  Generates badges from a file.

Options:
  INPUT_FILE                      The file to use for generation of badges.
                                  [required]
  -o, --output-file FILE          The file to output to.
  -p, --placement [header|inplace|footer]
                                  Specify where to place the badge.  [default:
                                  Placement.INPLACE]
  -h, --help                      Show this message and exit.

生成的徽章示例可以在 examples 目录中找到。

🤔 工作原理

  1. 它逐行读取给定的文件
  2. 它试图为每个单词找到 simple-icons
  3. 它用徽章替换单词

❤️ 贡献

欢迎贡献。如果您有任何问题,请提出问题或打开PR。谢谢。

项目详情


下载文件

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

源分布

auto-markdown-badges-0.2.1.tar.gz (7.9 kB 查看哈希值)

上传时间

构建分布

auto_markdown_badges-0.2.1-py3-none-any.whl (9.2 kB 查看哈希值)

上传时间 Python 3

支持者