Skip to content

Commit 3874723

Browse files
committed
docs: Enhance section name
1 parent f0c76f0 commit 3874723

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

README.md

+27-25
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,18 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
6969
- [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
7070
- [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
7171
- [Options](#options)
72-
- [⭐️ `github_token`](#%EF%B8%8F-github_token)
73-
- [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
74-
- [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
75-
- [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
76-
- [⭐️ `publish_dir`](#%EF%B8%8F-publish_dir)
77-
- [⭐️ `destination_dir`](#%EF%B8%8F-destination_dir)
78-
- [⭐️ CNAME](#%EF%B8%8F-cname)
79-
- [⭐️ Enable Built-in Jekyll](#%EF%B8%8F-enable-built-in-jekyll)
80-
- [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
81-
- [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
82-
- [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
83-
- [⭐️ Force orphan](#%EF%B8%8F-force-orphan)
72+
- [⭐️ Set Runner's Access Token `github_token`](#%EF%B8%8F-set-runners-access-token-github_token)
73+
- [⭐️ Set SSH Private Key `deploy_key`](#%EF%B8%8F-set-ssh-private-key-deploy_key)
74+
- [⭐️ Set Personal Access Token `personal_token`](#%EF%B8%8F-set-personal-access-token-personal_token)
75+
- [⭐️ Target Branch `publish_branch`](#%EF%B8%8F-target-branch-publish_branch)
76+
- [⭐️ Source Directory `publish_dir`](#%EF%B8%8F-source-directory-publish_dir)
77+
- [⭐️ Deploy to Subdirectory `destination_dir`](#%EF%B8%8F-deploy-to-subdirectory-destination_dir)
78+
- [⭐️ Add CNAME file `cname`](#%EF%B8%8F-add-cname-file-cname)
79+
- [⭐️ Enable Built-in Jekyll `enable_jekyll`](#%EF%B8%8F-enable-built-in-jekyll-enable_jekyll)
80+
- [⭐️ Allow empty commits `allow_empty_commit`](#%EF%B8%8F-allow-empty-commits-allow_empty_commit)
81+
- [⭐️ Keeping existing files `keep_files`](#%EF%B8%8F-keeping-existing-files-keep_files)
82+
- [⭐️ Deploy to external repository `external_repository`](#%EF%B8%8F-deploy-to-external-repository-external_repository)
83+
- [⭐️ Force orphan `force_orphan`](#%EF%B8%8F-force-orphan-force_orphan)
8484
- [⭐️ Set Git username and email](#%EF%B8%8F-set-git-username-and-email)
8585
- [⭐️ Set custom commit message](#%EF%B8%8F-set-custom-commit-message)
8686
- [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag)
@@ -201,7 +201,7 @@ jobs:
201201

202202
## Options
203203

204-
### ⭐️ `github_token`
204+
### ⭐️ Set Runner's Access Token `github_token`
205205

206206
**This option is for `GITHUB_TOKEN`, not a personal access token.**
207207

@@ -217,7 +217,7 @@ GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in yo
217217

218218
For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
219219

220-
### ⭐️ `deploy_key`
220+
### ⭐️ Set SSH Private Key `deploy_key`
221221

222222
Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following.
223223

@@ -229,11 +229,10 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
229229
publish_dir: ./public
230230
```
231231

232-
### ⭐️ `personal_token`
232+
### ⭐️ Set Personal Access Token `personal_token`
233233

234234
[Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
235235

236-
237236
```yaml
238237
- name: Deploy
239238
uses: peaceiris/actions-gh-pages@v3
@@ -242,7 +241,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
242241
publish_dir: ./public
243242
```
244243

245-
### ⭐️ `publish_branch`
244+
### ⭐️ Target Branch `publish_branch`
246245

247246
A target branch to deploy to GitHub Pages. The default is `gh-pages`.
248247

@@ -254,7 +253,7 @@ A target branch to deploy to GitHub Pages. The default is `gh-pages`.
254253
publish_branch: master # default: gh-pages
255254
```
256255

257-
### ⭐️ `publish_dir`
256+
### ⭐️ Source Directory `publish_dir`
258257

259258
A source directory to deploy to GitHub Pages. The default is `public`.
260259

@@ -266,7 +265,10 @@ A source directory to deploy to GitHub Pages. The default is `public`.
266265
publish_dir: ./out # default: public
267266
```
268267

269-
### ⭐️ `destination_dir`
268+
### ⭐️ Deploy to Subdirectory `destination_dir`
269+
270+
*This feature is on beta.*
271+
*Any feedback is welcome at [Issue #324](https://github.com/peaceiris/actions-gh-pages/issues/324)*
270272

271273
A destination subdirectory on a publishing branch. The default is empty.
272274

@@ -278,7 +280,7 @@ A destination subdirectory on a publishing branch. The default is empty.
278280
destination_dir: subdir
279281
```
280282

281-
### ⭐️ CNAME
283+
### ⭐️ Add CNAME file `cname`
282284

283285
To add `CNAME` file, we can set the `cname` option.
284286

@@ -293,7 +295,7 @@ For more details about `CNAME`, read the official documentation: [Managing a cus
293295
cname: github.com
294296
```
295297

296-
### ⭐️ Enable Built-in Jekyll
298+
### ⭐️ Enable Built-in Jekyll `enable_jekyll`
297299

298300
If you want GitHub Pages to process your site with the static site generator Jekyll, set `enable_jekyll` to true.
299301

@@ -315,7 +317,7 @@ Bypassing Jekyll makes the deployment faster and is necessary if you are deployi
315317

316318
For more details about `.nojekyll`: [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
317319

318-
### ⭐️ Allow empty commits
320+
### ⭐️ Allow empty commits `allow_empty_commit`
319321

320322
By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` to `true`.
321323

@@ -330,7 +332,7 @@ For example:
330332
allow_empty_commit: true
331333
```
332334

333-
### ⭐️ Keeping existing files
335+
### ⭐️ Keeping existing files `keep_files`
334336

335337
By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`.
336338

@@ -345,7 +347,7 @@ For example:
345347
keep_files: true
346348
```
347349

348-
### ⭐️ Deploy to external repository
350+
### ⭐️ Deploy to external repository `external_repository`
349351

350352
By default, your files are published to the repository which is running this action.
351353
If you want to publish to another repository on GitHub, set the environment variable `external_repository` to `<username>/<external-repository>`.
@@ -374,7 +376,7 @@ A GitHub Free Plan account cannot use the GitHub Pages in a private repository.
374376
- `peaceiris/homepage`: A private repository running this action with `external_repository: peaceiris/peaceiris.github.io`
375377
- `peaceiris/peaceiris.github.io`: A public repository using GitHub Pages
376378

377-
### ⭐️ Force orphan
379+
### ⭐️ Force orphan `force_orphan`
378380

379381
We can set the `force_orphan: true` option.
380382
This allows you to make your publish branch with only the latest commit.

0 commit comments

Comments
 (0)