專案介紹

專案資訊

專案名稱：Eliza
用途概述：DOC 文件工具
授權：MIT

概述

本專案原為個人為私人用途開發，但後來接手公司IT業務後，內部撰寫文件需求增加。需要一套讓開發或非開發人員都能快速上手的文件構件工具，因此將此專案優化後開源。

倉庫地址：https://github.com/2460124601/Eliza_doc

架構示意圖

網站架構圖您只需要專注於描述文件內容，並配上簡單的Markdown語法，其餘的顯示、目錄可交由Eliza處理。

後端與環境

都端採用Ruby進行開發，並且已配置Dokcer，可透過Docker啟用

Docker 官方：https://www.docker.com/

使用以下指令，將會自動安裝Gem以及以開發者模式啟用。

docker-compose up --build dev

完整結構

Eliza/
├─ build.rb                 # 產生器主程式Kramdown+Nokogiri+ERB）
├─ template.html.erb        # 主要渲染模板
├─ watch_poll_serve.rb      # 熱更新
├─ serve.rb                 # 保持狀態
├─ content/                 # 內容（Markdown）
│   ├─ v1.0/
│   │   ├─ en/    # 01-overview.md, ...
│   │   └─ zh-TW/ # 01-overview.md, ...
│   └─ v2.4/
│       ├─ en/
│       └─ zh-TW/
├─ public/                  # 輸出
│   ├─ assets/              # 資源
│   └─                      # index.html, 01-*.html, ...
└─ config/                  
    └─ config.yml           # 配置文件

其他功能請參閱下章節。