Project Info
- Project Name: Eliza
- Purpose: DOC Documentation Tool
- License: MIT
Overview
This project was first created for personal use. Later, when I took over IT work at the company, the need for internal documentation increased. To help both developers and non-developers write docs easily, I improved the tool and made it open-source.
Repository: https://github.com/2460124601/Eliza_doc
Architecture Diagram
You only need to focus on writing content in Markdown. Eliza handles the layout and navigation automatically.
Backend & Environment
The backend is developed with Ruby and supports Docker.
- Docker official: https://www.docker.com/
Run the following command to install Gems and start in developer mode:
docker-compose up --build dev
Full Structure
Eliza/
├─ build.rb # Main generator (Kramdown + Nokogiri + ERB)
├─ template.html.erb # Main template
├─ watch_poll_serve.rb # Live reload
├─ serve.rb # starts a simple static server to keep the generated site accessible.
├─ content/ # Markdown files
│ ├─ v1.0/
│ │ ├─ en/ # 01-overview.md, ...
│ │ └─ zh-TW/ # 01-overview.md, ...
│ └─ v2.4/
│ ├─ en/
│ └─ zh-TW/
└─ public/ # Output folder
├─ assets/ # Assets
│ └─ # index.html, 01-*.html, ...
└─ config/ # 輸出
└─ config.yml # 配置文件
See the next chapter for more details.