# write-doc

**Repository Path**: haha1231/write-doc

## Basic Information

- **Project Name**: write-doc
- **Description**: 轻量级的使用markdown文档编写工具
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.ioio.pw/write-doc/demo
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-01-05
- **Last Updated**: 2024-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WriteDoc 
[English](./README.md)
 
[![Actions Status](https://github.com/heropoo/write-doc/workflows/Build/badge.svg)](https://github.com/heropoo/vue-project/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)

## 安装
通过composer安装
```
composer require write-doc/write-doc
```

## 使用
```
php builder.php demo
```

## 特性
* 使用markdown语法编写文档,API文档编写更简易
* 自动生成链接目录
* 自动生成链接跳转的锚点
* 使用`j`和`k`快捷键在api间快速跳转