ShowDoc的安装

ShowDoc介绍

关于ShowDoc的介绍，请访问：https://www.showdoc.cc/help

自动脚本安装

官方强烈推荐使用自动脚本安装showdoc，你只需要在命令行下执行命令即可。自动脚本安装教程：https://www.showdoc.cc/help?page_id=828455960655160 。假如自动脚本安装失败，你可以考虑手动安装。

手动安装

• docker安装
  如果你不想通过自动脚本，但是又想用docker来自定义安装，则可以参考教程https://www.showdoc.cc/help?page_id=65610
• php安装
  如果你不想使用自动脚本或者docker安装，showwdoc需要PHP5.3及以上版本（开启php-gd php-sqlite扩展），
• 你可以参考这里安装环境http://www.showdoc.cc/php 。安装完PHP环境后，下载代码：https://github.com/star7th/showdoc 。下载完毕后将代码放到PHP的web目录。一般来讲，不同系统的web目录路径不太一样。请根据你安装的环境来定。如果是windows下安装，可以参考这篇教程：https://www.showdoc.cc/help?page_id=4087044677189279
• 二次开发指引
  https://www.showdoc.cc/help?page_id=1385576954326448

升级安装

• 如果你是使用自动脚本安装showdoc，那么升级只需要执行命令./showdoc update
• 如果你原本是手动安装，但想通过自动脚本升级，则请参考教程中的“从手动方式升级到自动脚本方式”：https://www.showdoc.cc/help?page_id=828455960655160
• 如果你是使用docker方式安装，则请参考docker教程中“如何升级”部分：http://www.showdoc.cc/help?page_id=65610

• 如果你是手动安装环境的，则继续往下看。首先将旧代码目录复制一份以便备份。
• 全新安装（具体操作参考文档）并初始化ShowDoc完毕后，进入之前备份的目录。将Sqlite/showdoc.db.php（这是原来的数据库文件），以及Public/Uploads/下的所有文件（这些是上传的图片。如没有图片则可忽略之），全部复制并覆盖到新showdoc目录的相应文件。覆盖后重新给这些文件可写权限。覆盖文件后，用浏览器访问http://x.com/index.php?s=/home/update/db （请将网址更改为你服务器域名或ip）。看到OK字样便证明成功升级.

错误排查和建议反馈

• 常见问题：http://www.showdoc.cc/help?page_id=16118
• 对showdoc的问题或建议请至https://github.com/star7th/showdoc 处提issue。若觉得showdoc好用，不妨点个star。良好的关注度和参与度有助于开源项目的长远发展。

使用在线的ShowDoc

• 如果你没有自己的服务器，但又想使用ShowDoc作为分档分享工具，你可以使用在线的ShowDoc http://www.showdoc.cc
• http://www.showdoc.cc 作为在线服务会长期维护，请放心托管你的文档数据。使用在线服务时请记住showdoc唯一官方网址https://www.showdoc.cc

frm https://www.showdoc.cc/help?page_id=13732

----------------------------------------------------------------

开发文档管理系统ShowDoc

ShowDoc是一款开发文档开源管理系统，国人开发，遵循Apache2 开源协议。

功能：

    API文档

    随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

    数据字典

    一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。
    说明文档

    可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

特色

    分享与导出
        响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件，以便离线浏览。

    权限管理
        公开项目与私密项目
        ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。

        项目转让
        项目创建者可以自由地把项目转让给网站的其他用户。

        项目成员
        你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）

    编辑功能
        markdown编辑
        ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”

        模板插入
        在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。

        历史版本
        ShowDoc为页面提供历史版本功能，可方便地把页面恢复到之前的版本。

[repo owner=”star7th” name=”showdoc”]