https://github.com/met-moon/write-doc

A document writer 一个使用markdown编写文档的工具
https://github.com/met-moon/write-doc

api-documentation documentation-generator markdown-writer php-document write-doc

Last synced: 14 days ago
JSON representation

A document writer 一个使用markdown编写文档的工具

• Host: GitHub
• URL: https://github.com/met-moon/write-doc
• Owner: met-moon
• License: mit
• Created: 2018-01-23T06:43:03.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-14T16:24:34.000Z (over 4 years ago)
• Last Synced: 2025-08-15T18:34:11.377Z (6 months ago)
• Topics: api-documentation, documentation-generator, markdown-writer, php-document, write-doc
• Language: CSS
• Homepage:
• Size: 1.29 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README-CN.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# WriteDoc 

[English](./README.md)

 

[![Actions Status](https://github.com/heropoo/write-doc/workflows/Build/badge.svg)](https://github.com/heropoo/write-doc/actions)

[![Latest Stable Version](https://poser.pugx.org/write-doc/write-doc/v/stable)](https://packagist.org/packages/write-doc/write-doc)

[![Total Downloads](https://poser.pugx.org/write-doc/write-doc/downloads)](https://packagist.org/packages/write-doc/write-doc)

[![License](https://poser.pugx.org/write-doc/write-doc/license)](https://packagist.org/packages/write-doc/write-doc)

## 示例

- [示例1](https://met-moon.github.io/write-doc/demo)

- [示例2](https://met-moon.github.io/write-doc/demo2)

## 安装

通过composer安装

```

composer require write-doc/write-doc

```

## 使用

```

php builder.php demo

```

## 特性

* 使用markdown语法编写文档,API文档编写更简易

* 自动生成链接目录

* 自动生成链接跳转的锚点

* 使用`j`和`k`快捷键在api间快速跳转