Kitabu 项目技术文档

1. 安装指南

系统要求

• Ruby 3.2 或更高版本

安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 Kitabu：

   gem install kitabu
   

3. 安装完成后，运行以下命令检查外部依赖是否安装正确：

   kitabu check
   

   输出示例：

   Prince XML: Converts HTML files into PDF files.
   Installed.
   
   Calibre's ebook-convert: Converts ePub e-books into .mobi files.
   Installed.
   

   如果没有安装相关依赖，请根据提示进行安装。

2. 项目使用说明

创建新电子书

1. 运行以下命令创建一个新的电子书项目：

   kitabu new mybook
   

   这将创建一个名为 mybook 的目录，包含电子书的基本结构。

2. 目录结构如下：

   .
   ├── Gemfile
   ├── Gemfile.lock
   ├── Guardfile
   ├── assets
   │   ├── fonts
   │   ├── images
   │   │   ├── cover.png
   │   │   ├── kitabu.svg
   │   │   ├── markdown.svg
   │   │   └── up.svg
   │   ├── scripts
   │   └── styles
   │       ├── epub.css
   │       ├── html.css
   │       ├── pdf.css
   │       ├── print.css
   │       └── support
   │           ├── kitabu.css
   │           ├── normalize.css
   │           ├── notes.css
   │           └── toc.css
   ├── config
   │   ├── helpers.rb
   │   ├── kitabu.yml
   │   └── locales
   │       └── en.yml
   ├── templates
   │   ├── epub
   │   │   ├── cover.erb
   │   │   ├── page.erb
   │   │   └── toc.erb
   │   └── html
   │       └── layout.erb
   └── text
       ├── 01_Getting_Started.md
       ├── 02_Creating_Chapters.md
       ├── 03_Syntax_Highlighting.md.erb
       ├── 04_Dynamic_Content.md.erb
       ├── 05_Exporting_Files.md
       └── 06_Changelog.md
   

3. 在 text 目录中编写你的电子书内容。每个章节可以是一个文件夹或单独的文件，文件名应按顺序编号。

生成电子书

1. 编写完成后，运行以下命令生成电子书：

   kitabu export
   

   生成的电子书将保存在 output 目录中。

3. 项目API使用文档

前言

Markdown 文件（包括 .md.erb 文件）支持前言部分，可以在页面中注入变量。前言部分必须使用有效的 YAML 格式。

示例：

---
section: changelog
---

## Changelog

### Jan 26, 2024

- Initial release

使用 ERB

可以在 .md.erb 文件中混合使用 Markdown 和 HTML。

示例：

## 这是章节标题

<%= image_tag "myimage.png" %>

生成的内容将类似于：

<img src="images/myimage.png" />

语法高亮

使用围栏代码块进行代码高亮。

示例：

``` ruby
class User < ActiveRecord::Base
  validates_presence_of :login, :password, :email
  validates_uniqueness_of :login, :email
end

## 4. 项目安装方式

### 通过 RubyGems 安装
运行以下命令安装 Kitabu：
```bash
gem install kitabu

检查依赖

安装完成后，运行以下命令检查外部依赖：

kitabu check

创建新项目

运行以下命令创建一个新的电子书项目：

kitabu new mybook

生成电子书

编写完成后，运行以下命令生成电子书：

kitabu export