showdoc最新版所包括的功效特殊多,运用起来也利害常的轻快大略,动作一个深受大师爱好的api以及本领文档东西,你不妨用它来轻快编写百般文档实质等,操纵叶寒简单!
showdoc官方版简介
1.ShowDoc是一个特殊符合IT共青团和少先队的在线API文档、本领文档东西。经过showdoc,你不妨简单地运用markdown语法来抄写出场面的API文档、数据字典文档、本领文档、在线excel文档之类。
2.即使不想编纂markdown文档,你还不妨运用showdoc的机动化本领,从步调解释中机动天生API文档,大概从搭配的RunApi客户端(一致postman的api调节和测试东西)中一面调节和测试接口、一面机动天生文档。经过调配名目分子和共青团和少先队分子,你不妨很简单地举行名目文档的权力处置和共青团和少先队协调,也不妨瓜分文档出去给伙伴察看。
软件特性
--数据字典( 察看Demo)
一份好的数据字典不妨很简单地向旁人证明你的数据库构造,如各个字段的释义等。
--API文档( 察看Demo)
跟着挪动互联网络的兴盛,BaaS(后端即效劳)越来越时髦。效劳端供给API,APP端大概网页前者便可简单挪用数据。用ShowDoc不妨特殊简单赶快地编写出场面的API文档,同声还将扶助从代码文献中机动天生API文档
--证明文档(察看Demo )
你实足不妨运用showdoc来编写少许东西的证明书,也不妨编写少许本领典型证明文档以供共青团和少先队查看。
软件功效简介
--编纂功效
markdown编纂:ShowDoc沿用markdown编纂器,不管是编纂仍旧观赏领会都极佳很棒。即使你不领会Markdown,请在探求引擎探求”看法与初学 Markdown”
沙盘插入:在ShowDoc的编纂页面,点击编纂器上方的按钮可简单地插入API接口沙盘和数据字典沙盘。插入沙盘后,剩下的即是变换数据了,省去了很多编纂的力量。
汗青版本:ShowDoc为页面供给汗青版本功效,你不妨简单地把页面回复到之前的版本。
--瓜分与导出
相应式网页安排,可将名目文档瓜分到电脑或挪动摆设察看。同声也不妨将名目导出成word文献,再不离线欣赏。
--权力处置
公然名目与私密名目:ShowDoc上的名目有公然名目和私密名目两种。公然名目可供任何登录与非登录的用户考察,而私密名目则须要输出暗号考证考察。暗号由名目创造者树立。
名目让渡:名目创造者不妨自在地把名目让渡给网站的其余用户。
名目分子:你不妨很简单地为ShowDoc的名目增添、简略名目分子。名目分子不妨对名目举行编纂,但不行让渡或简略名目(惟有名目创造者才有权力)
共青团和少先队处置:运用showdoc的共青团和少先队功效你不妨更好地举行共青团和少先队协调
--多平台
showdoc扶助网页版、手机app版和电脑客户端版。客户端地方看来:https://www.showdoc.com.cn/clients
--机动化
可从代码解释中机动天生文档
搭配的RunApi客户端,可调节和测试接口和机动天生文档
罕见题目证明
忘怀了暗号如何办?
即使是运用在线ShowDoc,忘怀暗号的话可接洽xing7th@gmail.com,邮件中证明你的用户名和旗下名目名字(起码供给两个名目)。
即使是本人安置的ShowDoc,则开始按照前方安置文档举行晋级,保证运用最新代码(划中心)。而后,按照安置办法的各别有各别的暗号重置办法。
即使是运用官方剧本大概docker办法安置的,请在吩咐行实行吩咐:
docker exec showdoc bash -c "cd /var/www/html/ && php ./index.php home/common/repasswd"
即使是手动安置php办法的,则在吩咐行中切换到showdoc安置目次而后实行:
php index.php home/common/repasswd
之上吩咐会把处置员showdoc的暗号重置为123456 。用此暗号登录处置后盾即可处置普遍用户以及名目。倡导登录后窜改暗号。
若窜改暗号堕落,请保证本人沿用最新版代码。
缺点提醒”General error: 11 database disk image is malformed”
请保证效劳器安置好了php情况和php-sqlite扩充;
即使你以FTP办法上传代码到效劳器,那么请运用二进制形式上传,要不会妨碍数据库文献,引导此缺点提醒
缺点提醒 “Could not find driver”
慰问装php-pdo 和 pdo_sqlite 。
对于Windowns效劳器,在php.ini内里把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”起用再不打开对SQlite的扶助;
Linux效劳器安置php5.3之上版本时表面上默许是打开了php-pdo和pdo_sqlite的。即使你安置的PHP仍旧没有,则可探求搜集教程安置之。
独占版showdoc怎样贯穿数据库
showdoc运用sqlite数据库。数据库文献是安置目次下的Sqlite/showdoc.db.php。你不妨搜集探求怎样在吩咐行中运用 sqlite数据库.大概运用SQLiteStudio等可视化东西
如何加入处置后盾
新安置实行后,默许处置员账号是showdoc/123456 。运用处置员帐户登录后,在名目列表页面包车型的士右上角便能看到处置后盾进口。即使不许,请从新登录大概更新浏览器缓存试试
考证码不表露
请查看能否安置了php-gd库
默认解压密码:www.daque.cn
如需解压,请在本站下载飞压软件进行解压!
编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载编程工具 /
下载