开源项目 GSWL-book 使用教程
1. 项目的目录结构及介绍
GSWL-book 项目的目录结构如下:
GSWL-book/
├── 00-intro
├── 02-ledger-accounting
├── 03-the-setup
├── 04-reports
├── 05-update-journal
├── 06-advanced
├── 07-investing
├── 08-glossary
├── 09-end
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── Makefile
├── README.md
├── before.tex
├── epub_title.txt
├── html_header.html
├── pandoc.css
└── preprocess.py
目录介绍
00-intro
: 项目介绍部分。02-ledger-accounting
: 关于 Ledger 会计基础的介绍。03-the-setup
: 项目设置指南。04-reports
: 报告生成指南。05-update-journal
: 更新日志指南。06-advanced
: 高级功能介绍。07-investing
: 投资相关内容。08-glossary
: 术语表。09-end
: 结束部分。.gitignore
: Git 忽略文件配置。CHANGELOG.md
: 变更日志。LICENSE.md
: 项目许可证。Makefile
: 编译配置文件。README.md
: 项目说明文档。before.tex
: LaTeX 前置文件。epub_title.txt
: EPUB 标题文件。html_header.html
: HTML 头部文件。pandoc.css
: Pandoc 样式文件。preprocess.py
: 预处理脚本。
2. 项目的启动文件介绍
项目的启动文件主要是 Makefile
,它包含了生成 PDF 和其他格式的命令。以下是 Makefile
的基本内容:
# Makefile 内容示例
pdf:
pandoc -o book.pdf --pdf-engine=xelatex before.tex *.md
使用方法
- 克隆项目到本地:
git clone https://github.com/rolfschr/GSWL-book.git cd GSWL-book
- 生成 PDF 文件:
make pdf
3. 项目的配置文件介绍
项目的配置文件主要是 Makefile
和 pandoc.css
。
Makefile
Makefile
用于编译和生成项目文档,具体配置如上所述。
pandoc.css
pandoc.css
是用于 Pandoc 生成文档时的样式文件,定义了文档的外观和格式。
/* pandoc.css 内容示例 */
body {
font-family: Arial, sans-serif;
}
h1, h2, h3 {
color: #333;
}
通过以上配置文件,可以自定义生成的文档样式和编译过程。
以上是 GSWL-book 项目的使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!