markdown-it-py 项目教程

markdown-it-py 项目教程

markdown-it-pyMarkdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. Now in Python!项目地址:https://gitcode.com/gh_mirrors/ma/markdown-it-py

项目的目录结构及介绍

markdown-it-py 项目的目录结构如下：

markdown-it-py/
├── markdown_it/
│   ├── cli/
│   ├── common/
│   ├── helpers/
│   ├── presets/
│   ├── rules_block/
│   ├── rules_inline/
│   ├── tokenize/
│   ├── __init__.py
│   ├── __main__.py
│   ├── core.py
│   ├── main.py
│   ├── parser_block.py
│   ├── parser_inline.py
│   ├── renderer.py
│   ├── utils.py
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── .readthedocs.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
├── setup.cfg
├── setup.py

目录介绍

• markdown_it/: 包含项目的主要代码文件。
  • cli/: 命令行接口相关文件。
  • common/: 通用工具和模块。
  • helpers/: 辅助函数和工具。
  • presets/: 预设配置文件。
  • rules_block/: 块级规则。
  • rules_inline/: 行内规则。
  • tokenize/: 标记化处理模块。
  • __init__.py: 包初始化文件。
  • __main__.py: 主程序入口文件。
  • core.py: 核心处理模块。
  • main.py: 主逻辑文件。
  • parser_block.py: 块级解析器。
  • parser_inline.py: 行内解析器。
  • renderer.py: 渲染器。
  • utils.py: 工具函数。
• tests/: 测试文件。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• .readthedocs.yml: Read the Docs 配置。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• MANIFEST.in: 清单文件。
• README.md: 项目说明文档。
• pyproject.toml: 项目配置文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。

项目的启动文件介绍

项目的启动文件是 markdown_it/__main__.py。这个文件定义了项目的入口点，可以通过以下命令运行：

python -m markdown_it

项目的配置文件介绍

项目的配置文件主要包括以下几个：

• pyproject.toml: 定义了项目的构建系统和依赖。
• setup.cfg: 包含了项目的元数据和安装配置。
• setup.py: 安装脚本，用于打包和分发项目。

这些配置文件共同定义了项目的构建、安装和分发方式。

markdown-it-pyMarkdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. Now in Python!项目地址:https://gitcode.com/gh_mirrors/ma/markdown-it-py