mkdocs-pom-parser-plugin 1.0.3

mkdocs pom解析器插件

一个简单的mkdocs插件，它解析pom.xml文件并将其值作为模板环境变量公开。 当正在文档化的项目使用maven时，这很方便。在

注意：不支持多个pom.xml文件，但如果您感兴趣-请随意投稿。在

安装

pip install mkdocs-pom-parser-plugin

使用

将插件添加到您的mkdocs.yml

^{pr2}$

默认情况下，插件将导出所有常用的标记作为模板环境变量：

pom.xml	template variable
^{}	^{}
^{}	^{}
^{}	^{}
^{}	^{}
^{}	^{}
^{}	^{}
^{}	^{}
^{}	^{}

在您的.md文件中，您可以引用这些变量来生成文档中的dependency installation部分：

    <dependency>
        <groupId>{{ POM_GROUP_ID }}</groupId>
        <artifactId>{{ POM_ARTIFACT_ID }}</artifactId>
        <version>{{ POM_VERSION }}</version>
    </dependency>

如果您需要上面列表中缺少的字段-可以通过配置添加：

plugins:
  - pom-parser-plugin:
      path: ../pom.xml
      additional:
        # template key: valid xpath filter
        # will become usable via {{ POM_SCM_CONNECTION }} in the template.
        SCM_CONNECTION: ./scm/connection

发展

1. 运行./build.sh或
2. docker-compose up并检查localhost:8000

本地安装

1.pip install -e . && mkdocs build --config-file tests/resources/mkdocs.yml（仍可编辑）

或者

1. pip install ./.tox/dist/mkdocs*.tar.gz && mkdocs build --config-file tests/resources/mkdocs.yml

释放

1. ./create-release.sh创建标记。在
2. Github操作将完成其余的工作。在

标签：

• 项目

欢迎加入QQ群-->： 979659372

推荐PyPI第三方库

• Mopidy-dLeyna

  从数字媒体服务器播放音乐的mopidy扩展

• aiotext

  一体式文本处理器和清洁器。

• crontabber

  具有自我修复和作业依赖性的cron作业管理器。

• django-qurl-templatetag

  修改url查询字符串的django模板标记。

• cdsapi

  气候数据存储api

• signalfx-serverless-gcf

  signalfx python无服务器包装器

• gaetestbed

  gae testbed是一组简化appengine测试的测试用例

• tranchitella.recipe.fs

  创建文件和目录的构建方法

• cloudlab

  用于在aws上快速配置环境以用于类和性能实验室的工具。

• jderobot-interfaces-kibotics

  包含所有jderobot python接口的包

• django-closuretree

  django的高效树型数据结构

• cfutils

  色谱文件用途

• turuumymathpython

  没有项目描述

• redbrick

  一个小的示例包

• flask-sqlacodegen

  支持烧瓶的sqlalchemy自动模型代码生成器