-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
240 additions
and
176 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| # yamllint disable-line rule:truthy | ||
| on: | ||
| push: | ||
| paths-ignore: | ||
| - "**.md" | ||
| pull_request: | ||
| paths-ignore: | ||
| - "**.md" | ||
|
|
||
| env: | ||
| path: build/distrib/*/*.zip | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: xu-cheng/texlive-action/full@v1 | ||
| if: ${{ ! startsWith(github.ref, 'refs/tags/') }} | ||
| with: | ||
| run: | | ||
| l3build ctan | ||
| - uses: actions/upload-artifact@v3 | ||
| if: ${{ ! startsWith(github.ref, 'refs/tags/') }} | ||
| with: | ||
| path: | | ||
| ${{ env.path }} | ||
| - uses: xu-cheng/texlive-action/full@v1 | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| with: | ||
| run: | | ||
| apk add git | ||
| git config --global --add safe.directory '*' | ||
| l3build tag $(git tag | tail -n1) | ||
| l3build ctan | ||
| - uses: softprops/action-gh-release@v1 | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| with: | ||
| files: | | ||
| ${{ env.path }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| [ignore-by-title] | ||
| regex=.* | ||
| ignore=body-is-missing | ||
| # ex: filetype=dosini |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,138 +1,59 @@ | ||
| # njustthesis | ||
|
|
||
| Thesis template for [NJUST](https://njust.edu.cn). | ||
|
|
||
| ## License | ||
| [](https://results.pre-commit.ci/latest/github/Freed-Wu/njustthesis/master) | ||
| [](https://github.com/Freed-Wu/njustthesis/actions) | ||
|
|
||
| [](https://github.com/Freed-Wu/njustthesis/releases) | ||
| [](https://github.com/Freed-Wu/njustthesis/releases/latest) | ||
| [](https://github.com/Freed-Wu/njustthesis/issues) | ||
| [](https://github.com/Freed-Wu/njustthesis/issues?q=is%3Aissue+is%3Aclosed) | ||
| [](https://github.com/Freed-Wu/njustthesis/pulls) | ||
| [](https://github.com/Freed-Wu/njustthesis/pulls?q=is%3Apr+is%3Aclosed) | ||
| [](https://github.com/Freed-Wu/njustthesis/discussions) | ||
| [](https://github.com/Freed-Wu/njustthesis/milestones) | ||
| [](https://github.com/Freed-Wu/njustthesis/network/members) | ||
| [](https://github.com/Freed-Wu/njustthesis/stargazers) | ||
| [](https://github.com/Freed-Wu/njustthesis/watchers) | ||
| [](https://github.com/Freed-Wu/njustthesis/graphs/contributors) | ||
| [](https://github.com/Freed-Wu/njustthesis/graphs/commit-activity) | ||
| [](https://github.com/Freed-Wu/njustthesis/commits) | ||
| [](https://github.com/Freed-Wu/njustthesis/releases/latest) | ||
|
|
||
| [](https://github.com/Freed-Wu/njustthesis/blob/master/LICENSE) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| This work may be distributed and/or modified under the conditions of GPLv3+. | ||
| Thesis template for [NJUST](https://njust.edu.cn). | ||
|
|
||
| ## Dependent | ||
| <!-- mdformat-toc start --slug=github --no-anchors --maxlevel=6 --minlevel=2 --> | ||
|
|
||
| ### Required | ||
| - [Install](#install) | ||
| - [Use Package Manager](#use-package-manager) | ||
| - [Install From Source Code](#install-from-source-code) | ||
| - [Usage](#usage) | ||
|
|
||
| - A `LaTex` distribution. Such as | ||
| [texlive](https://github.com/TeX-Live/texlive-source). | ||
| - [cnlogo](https://github.com/yuxtech/cnlogo/) provides the logos of many | ||
| Chinese Universities. | ||
| <!-- mdformat-toc end --> | ||
|
|
||
| ## Install | ||
|
|
||
| ### Use Package Manager | ||
|
|
||
| ```shell | ||
| ```sh | ||
| tlmgr install njustthesis | ||
| ``` | ||
|
|
||
| ### Install From Source Code | ||
|
|
||
| ```shell | ||
| ```sh | ||
| git clone --depth=1 https://github.com/Freed-Wu/njustthesis | ||
| cd njustthesis | ||
| l3build install | ||
| ``` | ||
|
|
||
| ## Customize | ||
|
|
||
| Default values: | ||
|
|
||
| ```latex | ||
| \njustsetup{ | ||
| logo = \njustwhole[njust][0.5], % depend on cnlogo | ||
| cover-title = 毕业设计说明书, | ||
| author = 佚名, | ||
| id = 916101630000, | ||
| department = 电子工程与光电技术学院, | ||
| discipline = 电子工程与光电技术, | ||
| title = , | ||
| subtitle = , | ||
| supervisor = 张三, | ||
| associate-supervisor = 李四, | ||
| judge = 王五, | ||
| supervisor-title = 教授, | ||
| associate-supervisor-title = 教授, | ||
| judge-title = 教授, | ||
| year = \the\year, % the time of paper | ||
| month = \the\month, | ||
| day = \the\day, | ||
| abstract-prefix = 毕业论文, | ||
| signature = , | ||
| signature* = , % star means english | ||
| abstract-prefix = 毕业论文, | ||
| title* = , | ||
| subtitle* = , | ||
| header-title = 本科毕业设计说明书, | ||
| } | ||
| ``` | ||
|
|
||
| **Note**: Add `{}` around the string which contain ' ','=', and','. | ||
|
|
||
| Example: | ||
|
|
||
| ```latex | ||
| \documentclass{njustthesis} | ||
| \njustsetup{% | ||
| author = 张不三, | ||
| id = 916101630000, | ||
| discipline = 电子信息工程, | ||
| title = {论文名字带逗号,或空格 }, | ||
| subtitle = 所以加花括弧括起来, | ||
| title* = {English name}, | ||
| supervisor = , | ||
| supervisor-title = 教授, | ||
| judge = , | ||
| % signature = \includegraphics{signature.pdf}, | ||
| judge-title = 教授, | ||
| } | ||
| \usepackage{subfiles} | ||
| \begin{document} | ||
| \maketitle | ||
| \frontmatter | ||
| \tableofcontents | ||
| \listoffigures | ||
| \listoftables | ||
| \mainmatter% | ||
| % \subfile{subfiles/chapter1.tex} | ||
| \backmatter% | ||
| % \bibliography{refs/main.bib} | ||
| \appendix | ||
| % \subfile{subfiles/appendix1.tex} | ||
| \end{document} | ||
| ``` | ||
|
|
||
| See more [examples](https://github.com/Freed-Wu?tab=repositories&q=njust&language=tex). | ||
|
|
||
| ## Tips | ||
|
|
||
| ```shell | ||
| texdoc njusthesis | ||
| ``` | ||
|
|
||
| ## Todo | ||
|
|
||
| - [pandoc](https://github.com/jgm/pandoc) template for user can | ||
| write markdown then convert it to latex. | ||
| - Change format from `ctexbook` to `ctexart` in order to use | ||
| `beamerarticle.sty` more conveniently. | ||
|
|
||
| ## FAQ | ||
|
|
||
| Q: Why another wheel? | ||
|
|
||
| A: Because former wheels cannot satisfy me. Some even only provide a | ||
| `*.tex` not `*.cls`. So crude. | ||
|
|
||
| Q: 100% compatible with official `docx` template? | ||
|
|
||
| A: If you find something unreasonable, welcome to pull request! | ||
|
|
||
| More questions see [issues](https://github.com/Freed-Wu/njustthesis/issues). | ||
|
|
||
| ## Reference | ||
| ## Usage | ||
|
|
||
| - [thuthesis](https://github.com/tuna/thuthesis) May be the best thesis | ||
| template among all Chinese theses. Any one can learn something from it. Such | ||
| as literate programming, separation of content and presentation, etc. | ||
| See [config](docs/config.md). |
Oops, something went wrong.