VueDoc — a convenient API and technical documentation tool

What is VueDoc?

VueDoc is a documentation application powered entirely by JavaScript.

Homepage

Documentation page

A powerful Markdown editor

Running VueDoc

VueDoc runs in Docker to simplify deployment and keep changes to the host environment to a minimum. Once installed, it is ready to run.

Demo: https://doc.krunk.cn/

How VueDoc works

Are you sure you want to read how it works?

Backend

VueDoc's backend is powered by Node.js. It handles a small set of tasks, so it doesn't need a complex database. It stores all its data in JSON files and serves requests from memory.

That's why I call it a product powered entirely by JavaScript.

Data Persistence

VueDoc writes data to JSON files after a delay. For persistent storage, map the following directories in the container to local directories:

Docker path

Notes

1

/usr/src/app/data

JSON data

2

/usr/src/app/images

Images uploaded in articles

Front end

VueDoc's frontend is built with Vue.js as a static single-page application.

Interested?

Can't be bothered to reach out? Leave your QQ number in a comment, and if I have time, I might put a group together.