Before and during the small studio partners to complete a small project together, all I have written here md document, and then use the micro letter sent to him, and later take up a network to penetrate directly to md document generated html file c drive then placed in a folder allow access to a small partner, then feel too much trouble, contacted showdoc to use it. . .
What is ShowDoc
-
word document piecemeal placed team of different people there, people who need basic document by a roar, roar and then on the other side to receive the document qq mailbox or throw over. This communication may of course, just not efficient.
-
ShowDoc is a very suitable for online document sharing tools IT team, it can speed up the efficiency of communication between teams.
What you can do with it
- API documentation (see Demo)
With the development of mobile Internet, BaaS (ie, back-end services) increasingly popular. Server provides API, APP end or the front page can easily call data. With ShowDoc you can very easily and quickly write beautiful API documentation. - Data Dictionary (View Demo)
A good data dictionary can easily explain your database structure, such as interpretation and other various fields to others. - Documentation (see Demo)
You can use some of the tools showdoc to write instructions, you can also write some technical specification documents for inspection team
Installation process
Project address: https: //github.com/star7th/showdoc
- First, the server creates a folder and cd to the folder
mkdir showdoc
cd showdoc
- Then after installation by git project, or you can also be downloaded to a local computer directory to scp
git clone https://github.com/star7th/showdoc.git
- With the item then comes
Dockerfileto build the mirror
docker build -t --name showdoc ./
- Finally, run like a mirroring port
docker run -d --name showdoc -p 8080:80 showdoc
- Then you can access port 8080, and the initial administrator account password are showdoc 123456
- After completion of setting off into the container delete
installa folder, to prevent others reset
docker exec -it showdoc /bin/bash
