octopus
1.0.0
Octopus是一个无服务器，易于设置的内部Wiki页面，并具有内置软件图支持。它使用Markdown编写内容并使用GraphViz和FlowChart.js图来增强内容，以简化软件文档。
这是一个默认的Wiki页面：
章鱼是一个使用Google Firebase作为后端的Jamstack应用程序。您不需要Web服务器（例如Apache）或数据库（例如MySQL）来启动并运行它。您可以使用NetLify免费部署该应用程序。
要求用户登录以阅读或编辑Wiki（受支持的提供商：Google，GitHub，电子邮件/密码，Twitter和Phone），
创建用于阅读和编辑的访问规则（限制特定用户或auth域），
自定义域下的主机Wiki页面。
用Markdown语言创建新的Wiki页面，
编辑菜单（使用Markdown）轻松链接到Wiki页面，
在您的标记内容中包括GraphViz和Flowchart.js图，
查看谁目前正在阅读您的Wiki文章，
使用React（Create-Rexct-App）调整Wiki前端。
将此存储库克隆到您的计算机。
复制配置模板文件（ src/config/config.template.js ）到src/config/config.js 。
cp src/config/config.template.js src/config/config.js
注意：您可以将
src/config/config.js文件安全地提交到存储库。该文件不存储敏感凭据 - 无论如何，所有配置变量都将在.js文件中公开可用。
在此处创建一个新的Firebase项目：https：//firebase.google.com/
选择“将Firebase添加到您的Web应用程序”，然后将配置复制到步骤2中创建的src/config/config.js 。
在Firebase控制台中，转到身份验证>登录方法，选择一个提供商并启用它。章鱼已与Google和GitHub提供商进行了测试。
仍然在身份验证>登录方法部分中，添加将托管您的应用程序托管您的应用程序列表的域。
构建应用程序：
npm install npm run build
将build/目录部署到您的网络服务器。
您可以跳过网络服务器上托管该应用程序（上面安装指南的步骤8）。您需要的只是将应用程序部署到基于云的CDN提供商。
我们建议使用Netlify。
每次提交后，它将自动将您的分叉章鱼GitHub存储库部署到生产中。它还将准备一个可用的URL，您所有用户都可以立即访问。稍后，您可以设置一个自定义域，以使其看起来更专业。
注意：通过Netlify部署章鱼时，请在设置向导中填写以下详细信息：
构建命令：
npm run build
发布目录：build
默认情况下，任何用户都可以查看和编辑您的Wiki页面。可能这不是您所期望的！
要使您的内容仅访问您的公司，请访问Firebase Console > Database > “规则”并限制谁可以阅读和编辑您的Wiki页面。
如果您使用Google登录提供商，并且您的公司电子邮件地址以@livechatinc.com结束：这是一个示例规则：
{
"rules": {
".read": "auth.token.email.endsWith('@livechatinc.com')",
".write": "auth.token.email.endsWith('@livechatinc.com')"
}
}您可以在实时数据库规则文档中阅读有关可能的安全规则的更多信息。
章鱼的设计非常易于使用。
要创建一个新页面，只需输入您要创建的URL，例如： https://<your-octopus-domain>/test/new-page 。如果尚未创建此类页面，您将看到以下屏幕：
当您单击“创建此页面”时，将创建并填写默认内容并填写新页面，可以编辑：
页面准备就绪后，您可以轻松地将其包含在菜单中：
就是这样。将所有队友链接发送到章鱼，他们准备贡献了！
我们为什么要建造章鱼？
我们一直在努力寻找用于记录LiveChat内部系统的易于使用的软件。
我们希望为非技术人员贡献它很容易，并包括易于编辑的软件图。我们找不到令人满意的产品，所以我们已经建造了一个。
通过Create-React-App反应。
viz.js
Flowchart.js
火基
15.09.2017-“打开为.png”选项
13.09.2017-初始版本
bartoszolchówka / cto @ livechat
该项目是根据MIT许可证获得许可的 - 有关详细信息，请参见许可证文件
