Skip to content

Commit

Permalink
feat: Build for release
Browse files Browse the repository at this point in the history
  • Loading branch information
technote-space committed Sep 30, 2019
1 parent 30b007f commit fbd0090
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
14 changes: 7 additions & 7 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@
![behavior](https://raw.githubusercontent.com/technote-space/toc-generator/images/screenshot.gif)

## インストール
1. Setup workflow
1. 目次の位置を指定 (option)
```markdown
<!-- START doctoc -->
<!-- END doctoc -->
```
[詳細](https://github.com/thlorenz/doctoc#specifying-location-of-toc)
1. workflow を設定
例:`.github/workflows/toc.yml`
```yaml
on: push
Expand All @@ -49,12 +55,6 @@
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
1. 目次の位置を指定 (option)
詳細: https://github.com/thlorenz/doctoc#specifying-location-of-toc
```markdown
<!-- START doctoc -->
<!-- END doctoc -->
```
## オプション
### TARGET_PATHS
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
![behavior](https://raw.githubusercontent.com/technote-space/toc-generator/images/screenshot.gif)

## Installation
1. Specifying location of TOC (option)
e.g. `README.md`
```markdown
<!-- START doctoc -->
<!-- END doctoc -->
```
[detail](https://github.com/thlorenz/doctoc#specifying-location-of-toc)
1. Setup workflow
e.g. `.github/workflows/toc.yml`
```yaml
Expand All @@ -49,20 +56,14 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
1. Specifying location of TOC (option)
see: https://github.com/thlorenz/doctoc#specifying-location-of-toc
```markdown
<!-- START doctoc -->
<!-- END doctoc -->
```
## Options
### TARGET_PATHS
Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))
default: `'README.md'`
e.g. `'README.md,README.ja.md'`
### TOC_TITLE
TOC Title.
TOC Title.
default: `'**Table of Contents**'`
### COMMIT_MESSAGE
Commit message.
Expand Down
2 changes: 1 addition & 1 deletion build.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"tagName":"v1.3.0","branch":"gh-actions","tags":["v1.3.0","v1","v1.3"],"updated_at":"2019-09-30T09:56:40.564Z"}
{"tagName":"v1.3.1","branch":"gh-actions","tags":["v1.3.1","v1","v1.3"],"updated_at":"2019-09-30T11:46:24.634Z"}

0 comments on commit fbd0090

Please sign in to comment.