DISCOUNT 项目使用教程

DISCOUNT 项目使用教程

discount My C implementation of John Gruber's Markdown markup language 项目地址: https://gitcode.com/gh_mirrors/di/discount

1. 项目目录结构及介绍

DISCOUNT 是一个用 C 语言实现的 Markdown 渲染器，其目录结构如下：

discount/
├── cmake/
│   └── ...
├── msvc/
│   └── ...
├── tests/
│   └── ...
├── tools/
│   └── ...
├── COPYRIGHT
├── CREDITS
├── INSTALL
├── Makefile.in
├── README
├── VERSION
├── amalloc.c
├── amalloc.h
├── basename.c
├── configure.inc
├── configure.sh
├── css.c
├── cstring.h
├── docheader.c
├── dumptree.c
├── emmatch.c
├── flagprocs.c
├── flags.c
├── generate.c
├── gethopt.3
├── gethopt.c
├── gethopt.h
├── github_flavoured.c
├── h1title.c
├── html5.c
├── libmarkdown.pc.in
├── main.c
├── makepage.1
├── makepage.c
├── markdown.1
├── markdown.3
├── markdown.7
├── markdown.c
├── markdown.h
├── mkd-callbacks.3
├── mkd-extensions.7
├── mkd-functions.3
├── mkd-line.3
├── mkd2html.1
├── mkd2html.c
├── mkdio.c
├── mkdio.h.in
├── mktags.c
├── notspecial.c
├── pgm_options.c
├── pgm_options.h
├── resource.c
├── setup.c
├── tags.c
├── tags.h
├── theme.1
├── theme.c
├── toc.c
├── v2compat.c
├── version.c.in
├── xml.c
└── xmlpage.c

• cmake, msvc, tests, tools: 这些目录包含项目构建、测试和工具相关的文件。
• COPYRIGHT, CREDITS, INSTALL, README, VERSION: 这些文件包含项目的版权信息、贡献者列表、安装指南、项目介绍和版本信息。
• 其他 .c 和 .h 文件：这些是项目的主要源代码和头文件。

2. 项目的启动文件介绍

项目的启动文件是 main.c，这是程序的入口点。以下是 main.c 文件的基本结构：

#include "markdown.h"
#include "html5.h"
#include "version.h"
// 其他必要的头文件

int main(int argc, char **argv) {
    // 程序的初始化和参数处理
    // Markdown 文本的解析和转换
    // 清理资源并退出程序
    return 0;
}

在 main.c 中，程序会解析命令行参数，对 Markdown 文本进行解析，并转换为 HTML 输出。

3. 项目的配置文件介绍

项目的配置文件是 configure.sh 和 Makefile.in。

• configure.sh: 这是一个 shell 脚本，用于检查系统环境、检测必要的库和头文件，并生成 Makefile。

• Makefile.in: 这是 Makefile 的模板文件，configure.sh 脚本会根据检测到的系统环境生成最终的 Makefile 文件。

在使用项目之前，你需要运行 configure.sh 脚本来生成 Makefile，然后使用 make 命令来编译项目。

./configure.sh
make

以上步骤会编译项目并生成可执行文件，你可以根据 INSTALL 文件中的说明来安装和使用这个项目。

discount My C implementation of John Gruber's Markdown markup language 项目地址: https://gitcode.com/gh_mirrors/di/discount