Showdoc

Showdoc official version is an efficient and practical online API document editing tool. The latest version of Showdoc has powerful functions that can help developers quickly write beautiful and practical API documents. The official version of Showdoc supports users to automatically generate API documents from code files, and can also add multiple teams and assign projects to improve overall office efficiency.

Showdoc software features

​ 1. Editing function

(1) markdown editing

The official version of Showdoc uses markdown editor, which provides a great editing and reading experience. If you don’t know Markdown, please search for “Understanding and Getting Started” in the search engine Markdown"

(2) Template insertion

On the editing page of ShowDoc, click the button above the editor to easily insert API interface templates and data dictionary templates. After inserting the template, all that's left is to change the data, saving a lot of editing effort.

(3) Historical version

ShowDoc provides a historical version function for the page, and you can easily restore the page to the previous version.

​​ 2. Share and export responsive web design, you can share project documents to a computer or mobile device for viewing. At the same time, you can also export the project into a word file for offline browsing.

3. Permission management

(1) Public projects and private projects

There are two types of projects on ShowDoc: public projects and private projects. Public projects can be accessed by any logged-in or non-logged-in user, while private projects require a password to authenticate access. The password is set by the project creator.

(2)Project transfer

Project creators can freely transfer projects to other users of the site.

(3)Project members

You can easily add and delete project members to ShowDoc projects. Project members can edit the project, but cannot transfer or delete the project (only the project creator has permission)

(4)Team management

You can add multiple teams by yourself, assign different projects to the teams, and set the permissions of everyone in the team.

How to use Showdoc

Install:

​​​ #Download the script and grant permissions

​​​ #The Chinese version is installed by default. If you want to install the English version, please add the en parameter, such as ./showdoc en

./showdoc

Other commands:

​​​ #Execute the above command and the installation will be completed automatically. Attached below are other commands in the script so that they can be used when managing showdoc.

#stop

./showdoc stop

​​​ #restart

./showdoc restart

​​​ #Upgrade showdoc to the latest version

./showdoc update

​​​ #Uninstall showdoc

./showdoc uninstall

Showdocchange log

​​ 1. Simple and friendly interface

2. Performance experience optimization and improvement

3. Fixed known bugs