Skip to content

Commit 4106962

Browse files
committed
Update README
Add description that string of elements of topics must not include spaces
1 parent 6684bea commit 4106962

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README/en.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Your Markdown articles need to include a YAML header like this.
9999
```yaml
100100
---
101101
title: "Your awesome title"
102-
topics: ["GitHub Actions", "Ruby", "YAML"]
102+
topics: ["GitHubActions", "Ruby", "YAML"]
103103
published: true
104104
---
105105
@@ -109,7 +109,7 @@ Your article starts here.
109109
| Key | Description | Type | Constraint |
110110
| ----------- | --------------------------------------------------------------- | -------------------------------------- | ------------ |
111111
| `title` | Specify a title of an article | `String` | |
112-
| `topics` | Specify tags of an article that describes its attributes | `Array[String, <String, String, ...>]` | Up to 5 tags |
112+
| `topics` | Specify tags of an article that describes its attributes | `Array[String, <String, String, ...>]` | Up to 5 tags<br>• The string of the elements must not include spaces |
113113
| `published` | Specify whether an article will be posted publicly or privately | `Boolean` | |
114114

115115
Note that your article file must start with `---`.

README/ja.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ jobs:
9999
```yaml
100100
---
101101
title: "Your awesome title"
102-
topics: ["GitHub Actions", "Ruby", "YAML"]
102+
topics: ["GitHubActions", "Ruby", "YAML"]
103103
published: true
104104
---
105105
@@ -109,7 +109,7 @@ Your article starts here.
109109
| キー | 説明 | 型 | 制約 |
110110
| --- | --- | --- | --- |
111111
| `title` | 記事のタイトルを指定します | 文字列 | |
112-
| `topics` | 記事のタグを指定します | 配列[文字列, <文字列, 文字列, ...>] | タグの数は 1 〜 5 個まで |
112+
| `topics` | 記事のタグを指定します | 配列[文字列, <文字列, 文字列, ...>] | タグの数は 1 〜 5 個まで<br>• 要素内の文字列にスペースは含めるのは不可 |
113113
| `published` | 一般公開するか限定共有にするかを指定します | 真偽値 | |
114114

115115
記事のファイルは `---` から始める必要があります。

0 commit comments

Comments
 (0)