Skip to content

Commit

Permalink
Merge pull request #54 from givery-technology/shunjikonishi-patch-1
Browse files Browse the repository at this point in the history
Remove preview from how-to-make-book
  • Loading branch information
shunjikonishi authored Sep 27, 2023
2 parents ecf287c + 4f68f69 commit 8efafd9
Showing 1 changed file with 0 additions and 37 deletions.
37 changes: 0 additions & 37 deletions docs/ja/how-to-make-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ book.ymlはBook全体の定義が記述されたファイルです。
- cover: String, 任意
- files: List[String], 任意
- images: List[String], 任意
- preview: String, 任意
- download: Boolean, 任意
- playground: Boolean, 任意
- webStorage: Boolean, 任意
Expand Down Expand Up @@ -123,42 +122,6 @@ filesに指定したファイルはBookReaderのワークスペース上でタ

imagesはあくまで説明文中で使用するための画像です。

### preview
previewにはブックの詳細ページで表示されるプレビューページを指定します。
指定の方法は以下のいずれかです。

#### ファイルを指定する

```
preview: preview.html
```

この場合は、指定したファイルは必ずそのパスになければなりません。
css, scriptを使用する場合は外部ファイルとはせず、HTML内にインラインで定義してください。

#### sectionを指定する(aliasでの指定)
各チャプター定義ファイルのセクション定義に`alias`が定義されている場合は、その値を指定することができます。

```
preview:
- section: mysection1
```

この場合、指定されたセクションのプレビューがブックのプレビューとして使用されます。

#### sectionを指定する(indexでの指定)
チャプターとセクションのインデックスを指定して、セクションを指定することもできます。

```
preview:
- chapter: 2-1
```

previewを指定しなかった場合は、最後のセクションの内容がプレビューとなります。
remoteブック(Java, Rubyなど)の場合はセクションのソースコードがプレビューとなります。

※ trackではプレビューは使用されていません。

### download
ブックの各セクションがダウンロード可能かどうかを指定します。
省略した場合のデフォルト値は`true`です。
Expand Down

0 comments on commit 8efafd9

Please sign in to comment.