https://github.com/wamisnet/css_book_template

https://github.com/wamisnet/css_book_template

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wamisnet/css_book_template
• Owner: wamisnet
• Created: 2020-02-03T12:58:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T06:21:21.000Z (almost 2 years ago)
• Last Synced: 2024-04-09T23:04:23.204Z (8 months ago)
• Language: CSS
• Size: 7.2 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-vivliostyle - css_book_template - Re:VIEW ではなく、CSS で本を書くときに必要になるデータをひとまとめにしました。 (Starters & Templates)
• awesome-vivliostyle - css_book_template - Re:VIEW ではなく、CSS で本を書くときに必要になるデータをひとまとめにしました。 (Starters & Templates)

README

        
# Re:VIEWじゃなくて、CSSで本を書こう！

Re:VIEWではなく、CSSで本を書くときに必要になるデータをひとまとめにしました。

Vivliostyleという技術で作成されています。GitHub Actionsを使ってビルドできます。

## ファイル構成

 - .github : GitHub Actionsを使って、コミットするとPDFをビルドします。

 - build : markdownをHTMLに変換するコードが含まれています。拡張構文を作れます。

 - content : 本文のデータ

 - scss : 本のデザインが含まれます。fontやデザインの変更を行えます。

## 作成フロー

1. このレポジトリを手元にクローンし、`npm i`をします。

2. 本を作成するため、`npm run build`をします。

3. `book.pdf`というファイルが生成されます。

## コマンド紹介

`npm run ○○`といった形で指定します。

- `start` : ファイルに変更があると自動的にマークダウンからHTMLとCSSのビルドを行い、プレビュー画面を表示します。

（ファイル更新時要リロード）（内部的に`watch`と`preview`を呼び出しています）

- `build` : PDFファイルのビルドを行います。

- `lint` : 文字構成に問題がないかlintを行います。

- `watch` : ファイルに変更があると自動的にマークダウンからHTMLとCSSのビルドを行います。

- `preview` : HTMLとCSSのビルドを行い、プレビューを表示します。

## 開発環境

 - Node.js 12.14.1

 

## 注意事項

### buildに時間がかかりすぎる

なんらかのファイルに問題がある可能性が高いです。

### GitHub Actionsのビルドに失敗する

手元では問題なくbuildできるのに、ActionsのPDF生成部分で失敗する場合、何度か時間をおいてリトライすると問題なく生成される現象を確認しています。

（特に初回）