├── Rmd
├── 020-relatedwork.Rmd
├── 010-introduction.Rmd
├── 030-figure.Rmd
└── 040-table.Rmd
├── docs
├── SJTUThesis.pdf
└── images
│ └── doctor.png
├── images
├── sjtubadge.pdf
├── sjtubanner.pdf
└── sjtulogo.pdf
├── _bookdown.yml
├── documentation
├── user.md
└── dev.md
├── bib
└── thesis.bib
├── Makefile
├── _output.yml
├── SJTUThesis-Markdown.Rproj
├── index.Rmd
├── README.md
├── LICENSE
├── _render.R
├── template
└── template.tex
├── .gitignore
├── latex
└── abstract.tex
├── sjtuthesis.cfg
└── sjtuthesis.cls
/Rmd/020-relatedwork.Rmd:
--------------------------------------------------------------------------------
1 | # 相关工作
2 |
3 | 这里是相关工作
4 |
--------------------------------------------------------------------------------
/Rmd/010-introduction.Rmd:
--------------------------------------------------------------------------------
1 | # 引言
2 |
3 | 这里是引言部分\cite{IEEE-1363}
4 |
--------------------------------------------------------------------------------
/docs/SJTUThesis.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dyweb/SJTUThesis-Markdown/HEAD/docs/SJTUThesis.pdf
--------------------------------------------------------------------------------
/images/sjtubadge.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dyweb/SJTUThesis-Markdown/HEAD/images/sjtubadge.pdf
--------------------------------------------------------------------------------
/images/sjtubanner.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dyweb/SJTUThesis-Markdown/HEAD/images/sjtubanner.pdf
--------------------------------------------------------------------------------
/images/sjtulogo.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dyweb/SJTUThesis-Markdown/HEAD/images/sjtulogo.pdf
--------------------------------------------------------------------------------
/docs/images/doctor.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dyweb/SJTUThesis-Markdown/HEAD/docs/images/doctor.png
--------------------------------------------------------------------------------
/_bookdown.yml:
--------------------------------------------------------------------------------
1 | book_filename: SJTUThesis
2 | rmd_subdir: TRUE
3 | clean: [packages.bib, bookdown.bbl]
4 | delete_merged_file: TRUE
5 |
--------------------------------------------------------------------------------
/documentation/user.md:
--------------------------------------------------------------------------------
1 | # 使用指南
2 |
3 | 使用这一模板，共有两处地方需要修改，分别是 `index.Rmd` 和 `Rmd` 目录。
4 |
5 | ## `index.Rmd`
6 |
7 | 修改其中的个性化配置，比如姓名等。
8 |
9 | ## `Rmd`
10 |
11 | 该目录是真正书写论文的地方。
12 |
--------------------------------------------------------------------------------
/bib/thesis.bib:
--------------------------------------------------------------------------------
1 | @book{IEEE-1363,
2 | author={IEEE Std 1363-2000},
3 | title={IEEE Standard Specifications for Public-Key Cryptography},
4 | address={New York},
5 | publisher={IEEE},
6 | year={2000}
7 | }
8 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | TEX_DIR = tex
2 | RMD_DIR = Rmd
3 |
4 | pdf:
5 | Rscript --quiet _render.R "bookdown::pdf_book"
6 |
7 | gitbook:
8 | Rscript --quiet _render.R "bookdown::gitbook"
9 |
10 | all:
11 | Rscript --quiet _render.R
12 |
--------------------------------------------------------------------------------
/_output.yml:
--------------------------------------------------------------------------------
1 | bookdown::pdf_book:
2 | keep_tex: yes
3 | dev: "cairo_pdf"
4 | latex_engine: xelatex
5 | citation_package: biblatex
6 | template: template/template.tex
7 | pandoc_args: "--top-level-division=chapter"
8 | toc_depth: 3
9 | toc_unnumbered: no
10 | toc_appendix: yes
11 |
--------------------------------------------------------------------------------
/SJTUThesis-Markdown.Rproj:
--------------------------------------------------------------------------------
1 | Version: 1.0
2 |
3 | RestoreWorkspace: Default
4 | SaveWorkspace: Default
5 | AlwaysSaveHistory: Default
6 |
7 | EnableCodeIndexing: Yes
8 | UseSpacesForTab: Yes
9 | NumSpacesForTab: 2
10 | Encoding: UTF-8
11 |
12 | RnwWeave: Sweave
13 | LaTeX: pdfLaTeX
14 |
15 | BuildType: Makefile
16 |
--------------------------------------------------------------------------------
/Rmd/030-figure.Rmd:
--------------------------------------------------------------------------------
1 | # 示例图
2 |
3 | 这里是插入图片的示例，如不想显示代码在 option 里添加 `echo=FALSE`。比如 `{r logo, out.width='32.8%', fig.show='hold', fig.cap='logo', fig.align="center, echo=FALSE"}`
4 |
5 |
6 | ```{r logo, out.width='32.8%', fig.show='hold', fig.cap='logo', fig.align="center"}
7 | knitr::include_graphics("images/sjtulogo.pdf")
8 | ```
9 |
--------------------------------------------------------------------------------
/Rmd/040-table.Rmd:
--------------------------------------------------------------------------------
1 | # 表格示例
2 |
3 | 如表 \@ref(tab:tab-single) 所示，这里是插入表格的示例，如不想显示代码在 option 里添加 `echo=FALSE`。比如 `{r table-single, tidy=FALSE, echo=FALSE}`
4 |
5 |
6 | ```{r tab-single, tidy=FALSE}
7 | knitr::kable(
8 | head(mtcars[, 1:8], 10), booktabs = TRUE,
9 | caption = 'A table of the first 10 rows of the mtcars data.'
10 | )
11 | ```
12 |
--------------------------------------------------------------------------------
/documentation/dev.md:
--------------------------------------------------------------------------------
1 | # 开发者指南
2 |
3 | 本模板使用 bookdown 实现了由 R Markdown -> LaTeX -> PDF 的一系列转换，其中用到的依赖有：
4 |
5 | - bookdown
6 | - pandoc
7 | - Tex Live
8 |
9 | ## 实现原理
10 |
11 | 在 `template` 目录下定义了一个模板文件 `template.tex`，其利用 pandoc 的模板功能对 SJTUThesis 的 `thesis.tex` 文件进行了模板化的定义。在编译的过程中，bookdown 会将 `index.Rmd`中的配置注入到模板中并且在 `_book` 目录下生成真正的 tex 文件，随后对其进行编译。最后在 `_book` 中产生 PDF 文件
12 |
13 | ## 设计上的权衡
14 |
15 | 由于 bookdown 对 abstract 标签不支持，因此采取了一个 workaround，针对 abstract 一节保留了 tex 的编辑方式。
16 |
--------------------------------------------------------------------------------
/index.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "上海交通大学论文 bookdown 模板示例文档"
3 | author: "周杰伦"
4 | documentclass: sjtuthesis
5 | classoption: [doctor,oneside]
6 | studentnumber: "116037910024"
7 | school: "软件学院"
8 | advisor: "周星驰"
9 | major: "软件工程"
10 | defenddate: "`r format(Sys.Date(),format='%Y年%m月%d日')`"
11 | date: "`r format(Sys.Date(),format='%Y年%m月%d日')`"
12 |
13 | englishauthor: "Jay Zhou"
14 | englishadvisor: "Xingchi Zhou"
15 | englishinstitute: "School of Software"
16 | englishdate: "`r format(Sys.Date(),format='%b. %d, %Y')`"
17 | englishtitle: "A Sample Document for Bookdown-Based SJTU Thesis Template"
18 | englishmajor: "Software Engineering"
19 |
20 | bibliography: [bib/thesis.bib]
21 |
22 | link-citations: yes
23 | colorlinks: yes
24 | lot: no
25 | lof: no
26 | ---
27 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # SJTUThesis-Markdown
2 |
3 | 上海交通大学学位论文 R Markdown (bookdown) 模板，示例文档可见 [SJTUThesis.pdf](https://dongyueweb.com/SJTUThesis-Markdown/SJTUThesis.pdf)。
4 |
5 | ## 效果展示
6 |
7 |
8 |
9 |