Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/being24/latex-template-ja

できるだけ簡単にLaTeX環境を構築できるようにするテンプレート
https://github.com/being24/latex-template-ja

devcontainer docker latex latex-template

Last synced: 4 months ago
JSON representation

できるだけ簡単にLaTeX環境を構築できるようにするテンプレート

Awesome Lists containing this project

README

        

# 日本語論文をLaTeXで書いて、textlintをするためのテンプレート

[![Test Docker Image](https://github.com/being24/latex-template-ja/actions/workflows/test.yml/badge.svg)](https://github.com/being24/latex-template-ja/actions/workflows/test.yml)
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)

## 機能

* 個人環境にLaTeX workshopを構築せず、dockerでビルドします
* GitHub Actionsを使用してtextlintを実行します
* github上にreleaseします
* レジュメや論文用のテンプレートを持ちますが、あくまで個人の環境用に構築したものです

## 環境

* Windows 10 or later
* macOS 10.14 or later
* Ubuntu 18.04 LTS or later

Docker環境が必要ですが、clsファイルについては多少弄ればCloud LaTeX等でも使用できます

* Docker Desktop for Mac 2.1 or later
* Docker 18.06 or later
* Docker Desktop for Windows

ghcr.io/being24/latex-docker を使用します
ビルド用のdocker imageは[こちらのリポジトリ](https://github.com/being24/latex-docker)を参照してください

また、VSCodeが必要です

![demo](example/figures/screenshot.png)

## 使い方

使い方やFAQはこの[記事](https://zenn.dev/being/articles/how-to-use-my-latex)にまとめています

## License

CC0

## Author

Being

## config

VSCode上での設定例は[settings.json](.vscode/settings.json)を参照してください

## テンプレートについて

できるだけ現代的な設定を意識して作成したテンプレートですが、LaTeXに詳しいわけではないので誤りがあった場合は教えていただけると幸いです
実際の使用時はexample等必要のないファイルは消してください

jlistingの代わりにmintedを使用し、参考文献はbiblatexを使用します
(mintedは環境によっては使用できないため、コメントアウトしてあります)

### resume.cls

[resume.cls](/classes/resume.cls)は2段組みのレジュメを作成するためのクラスファイルです
使用方法は[例](/example/tex/resume_template.tex)を参照してください

### report.cls

[report.cls](/classes/report.cls)は論文を作成するためのクラスファイルです
使用方法は[例](/example/tex/report_template.tex)を参照してください

### .vscode/settings.jsonについて

使用しやすい設定を参考程度ですが上げておきます。
VSCodeであればこの設定を読み込んでくれるため、設定を変更する必要はありません

## 参考URL