lfphp/mdoc

此包的最新版本（0.0.2）没有提供许可证信息。

维护者

详细信息

github.com/sasumi/mdoc

源代码

问题

安装: 10

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

0.0.2 2023-01-06 03:17 UTC

Unknown License a792de84f3cd9dacd007540bca293d2697530be3

  • sasumi <cnsasumi.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-06 06:47:38 UTC

README

介绍

MDoc 是一个开源库，用于将 PHP 实现的 Markdown 格式文件部署成为 Web 服务。互联网人员经常使用 Markdown 格式编写各种文档，但由于 Markdown 的原始阅读体验（使用文本编辑软件阅读）较差，因此一般人都需要借助定制化软件进行查看或预览，效率较低。MDoc 系统可以在 PHP Web 服务能力上，通过简单的代码引入和执行，实现 Markdown 文档的线上化，在某些场景可以作为简单的文档查阅系统、博客使用。

快速使用

1、安装 Mdoc

composer require lfphp/mdoc

2、建立代码

<?php
    //引入代码库自动加载文件
    include "vendor/autoload.php";

	//初始化系统，指定markdown文件所在目录
    setup_mdoc([
        'root' => __DIR__.'/document', 
    ]);

3、（可选）定制化文档系统基本信息，通过文档根目录中的 config.ini 文件配置，可实现博客标题、作者、版权声明等更丰富的辅助信息呈现。配置项目说明：

# 系统标题
title = ""

# 系统作者
author = ""

# 系统联系方式
contact = ""

# 系统版权声明
copyrights = "© Copyright 2020, All Rights Reserved by PHP Coder."

# 更多系统描述
description = ""

更新

最新代码发布信息请访问 https://github.com/sasumi/mdoc。