YQdoc: A PHP-Based Documentation System Powered by Yuque API

Yuque is an online document editing and collaboration tool under Alibaba, supporting Markdown editing, import/export, and API functions, making it very convenient. Xiaoz developed the YQdoc documentation system based on the Yuque API. YQdoc is developed using PHP and its code is fully open source.

Benefits of Using YQdoc

1. Deployable on your own server and accessible via your own domain, which is beneficial for website SEO.
2. No Yuque official information displayed, resulting in a cleaner interface.
3. Supports custom templates, offering high customizability.

YQdoc Features

• Generates documentation based on the Yuque API.
• Supports page caching to improve loading speed and reduce API calls.
• Supports document Table of Contents (TOC).
• Fully open source with strong customizability.

Installing YQdoc

1. Register a Yuque account at https://www.yuque.com and enable API support.
2. Ensure your environment supports PHP (>=5.6).
3. Refer to the help documentation: YQdoc Help Documentation to install YQdoc.

Additional Information

• Demo: https://blog.xiaoz.org/doc/
• Source Code: https://github.com/helloxz/yqdoc