Skip to content

Commit 7e50dd8

Browse files
authored
Update docs
1 parent 75bf2e1 commit 7e50dd8

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,13 @@ These options should go in your repository's `.github/announcement-drafter.yml`
6161
| `watch_folders` | A list of what folders (relative paths) `announcement-drafter` should watch when new pull requests are open<br/>&nbsp;&nbsp;1. It is recommened to include the final `/` in the path<br/>&nbsp;&nbsp;2. `announcement-drafter` will also watch all subfolders unless you ignore them in `ignore_folders` | Yes | [See demo config][announcement-drafter demo config] |
6262
| `ignore_folders` | A list of what folders (relative paths) `announcement-drafter` should _ignore_ when new pull requests are open | No | [See demo config][announcement-drafter demo config] |
6363

64-
<details>
65-
<summary>Example announcement-drafter.yml</summary>
64+
Example announcement-drafter.yml:
6665

67-
```markdown
66+
```yml
6867
watch_folders:
6968
- docs/team-posts/
7069
```
7170

72-
</details>
73-
7471
### Discussion Markdown
7572

7673
`announcement-drafter` needs to know certain information such as what repository or team to create the discussion in, and what the discussion category should be. This information should be provided in YAML metadata at the top of your markdown file.
@@ -79,8 +76,7 @@ watch_folders:
7976

8077
See the [demo repository](https://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo/hello-world.md?plain=1) for more.
8178

82-
<details>
83-
<summary>Draft a Repository Discussion</summary>
79+
##### Draft a Repository Discussion
8480

8581
```markdown
8682
<!--
@@ -95,10 +91,7 @@ Hello beautiful world! 🌎
9591
9692
```
9793

98-
</details>
99-
100-
<details>
101-
<summary>Draft a Team Post</summary>
94+
##### Draft a Team Post
10295

10396
```markdown
10497
<!--
@@ -112,8 +105,6 @@ Hello beautiful world! 🌎
112105
113106
```
114107

115-
</details>
116-
117108
#### Metadata
118109

119110
| Name | Description | Required | Example |

0 commit comments

Comments
 (0)