YQdoc: A Documentation System Developed Based on Yuque API

Publish: 2019-05-12 | Modify: 2019-05-12

YQdoc is an online document editing and collaboration tool under Alibaba, which supports not only Markdown editing but also import, export, API, and other functions. It is very convenient to use. Xiaoz has developed the YQdoc documentation system based on the YQdoc API, which is developed in PHP and the code is completely open source.

What are the benefits of using YQdoc?

  1. It can be deployed on your own server and accessed through your own domain name, which is conducive to website SEO.
  2. No official information from Yuque, which makes it cleaner.
  3. You can develop your own templates with strong customizability.

YQdoc features

  • Generate documents based on the Yuque API.
  • Support page caching to improve loading speed and reduce API calls.
  • Support document TOC (Table of Contents).
  • Completely open source with strong customizability.

Installing YQdoc

  1. Register a Yuque account first: https://www.yuque.com and enable API support.
  2. Make sure the environment supports PHP (>=5.6).
  3. Refer to the documentation: YQdoc Documentation for YQdoc installation.

Others


Comments