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許可證獲得許可的 - 有關詳細信息，請參見許可證文件
