My Vivliostyle Report Template

理工学系分野で使用するレポートのためのテンプレート

created by create-book.

このテンプレートは

• 作者：理工系大学一年生
• 対象：大学の物理・数学・化学などのレポート

サンプル

• 台本(manuscript.md)
• PDF(output.pdf)
• スタイルシート

使い方（準備中）

• 使用しているフォント
  • Noto Sans JP
    • https://fonts.google.com/noto/specimen/Noto+Sans+JP
  • Noto Serif JP
    • https://fonts.google.com/noto/specimen/Noto+Serif+JP
  • 源ノ角ゴシック Code JP
    • https://github.com/adobe-fonts/source-han-code-jp/blob/master/README-JP.md
• VSCode 拡張機能
  • Run On Save
    • https://marketplace.visualstudio.com/items/?itemName=emeraldwalk.RunOnSave
• GhostscriptとPopplerをインストール
  • sudo apt-get install poppler-utils ghostscript

目指すもの（未完成）

• 使用できる状態にするために
  • フォント
    • 大体完了
  • 文字サイズ
  • ヘッダー
  • ページ番号
    • 左右の端に寄せることもできるようにしたい
• 数式
  • 数式番号を振る
    • おそらく問題なし
• 枠
  • 数式とか定義とかの枠
  • 見出しのありなしを両方とも
    • たぶん完成した
• 改ページ
• 図表の挿入
• コードブロック
  • コードブロックらしく見た目を整える
• 執筆環境
  • 保存のたびにPDFを生成
    • settings.jsonに設定した
    • VSCodeの拡張機能Run On Saveが必要

参考資料

コミットメッセージ

feat: 新しい機能を完成させた
fix: バグを修正した
docs: ドキュメントのみを変更した
style: 空白・セミコロン・ピリオドなどのフォーマットのみを編集した
refactor: リファクタリングをした
test: テストを編集した
chore: ビルド・補助ツール、ライブラリ等

リンク

• VFM https://vivliostyle.github.io/vfm/#/vfm
• Vivliostyle CLI https://github.com/vivliostyle/vivliostyle-cli#readme
• Vivliostyle Themes https://github.com/vivliostyle/themes#readme
• Awesome Vivliostyle https://github.com/vivliostyle/awesome-vivliostyle#readme
• Vivliostyle (GitHub) https://github.com/vivliostyle
• Vivliostyle https://vivliostyle.org

ファイル構成

├── .gitignore
├── .prettierrc     Prettier の設定ファイル
├── .vivliostyle     Vivliostyleが出力した一時ファイルの保存フォルダ
│   │                 gitで追跡しない
│   ├── assets
│   │   └── 1_銅線.png
│   ├── manuscript.html
│   ├── publication.json
│   ├── theme     自分で作ったテーマがコピーされるフォルダ
│   │   ├── my-prism-theme.css
│   │   └── my-report-theme.css
│   └── themes     インストールしたテーマがコピーされるフォルダ
│       ├── package-lock.json
│       ├── package.json
│       └── packages
│           ├── .package-lock.json
│           └── @vivliostyle
│               ├── theme-academic
│               │   ├── CHANGELOG.md
│               │   ├── LICENSE
│               │   ├── README.md
│               │   ├── example
│               │   │   ├── fet.html
│               │   │   ├── fet.md
│               │   │   ├── microcomputer.html
│               │   │   └── microcomputer.md
│               │   ├── package.json
│               │   ├── theme.css
│               │   └── vivliostyle.config.js
│               └── theme-base
│                   ├── CHANGELOG.md
│                   ├── LICENSE
│                   ├── README.md
│                   ├── css
│                   │   ├── common
│                   │   │   ├── basic.css
│                   │   │   ├── meta-properties.css
│                   │   │   └── reset.css
│                   │   ├── lib
│                   │   │   └── prism
│                   │   │       ├── base.css
│                   │   │       ├── theme-okaidia.css
│                   │   │       └── theme-prism.css
│                   │   └── partial
│                   │       ├── crossref.css
│                   │       ├── endnote.css
│                   │       ├── footnote-external-link.css
│                   │       ├── footnote.css
│                   │       ├── page.css
│                   │       ├── section.css
│                   │       ├── toc.css
│                   │       └── utility-classes.css
│                   ├── example
│                   │   ├── assets
│                   │   │   └── Logo (Mark + Type).png
│                   │   ├── default.html
│                   │   └── default.md
│                   ├── package.json
│                   ├── theme-all.css
│                   ├── theme-basic.css
│                   └── vivliostyle.config.js
├── .vscode     VSCodeの設定ファイル
│   ├── settings.json
│   └── tasks.json
├── LICENSE
├── README.md     このファイル
├── assets     画像置き場
│   └── 1_銅線.png
├── manuscript.md     原稿
├── output     生成したPDFが保存されるフォルダ
│   └── output.pdf
├── package-lock.json
├── package.json
├── theme     自分で定義するテーマを保存するフォルダ
│   ├── my-prism-theme.css
│   └── my-report-theme.css
└── vivliostyle.config.js     設定ファイル