Update docs

philip-gai · Dec 2, 2021 · 7e50dd8 · 7e50dd8
1 parent 75bf2e1
commit 7e50dd8
Showing 1 changed file with 4 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -61,16 +61,13 @@ These options should go in your repository's `.github/announcement-drafter.yml`
 | `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] |
 | `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] |
 
-<details>
-<summary>Example announcement-drafter.yml</summary>
+Example announcement-drafter.yml:
 
-```markdown
+```yml
 watch_folders:
   - docs/team-posts/
 ```
 
-</details>
-
 ### Discussion Markdown
 
 `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:
 
 See the [demo repository](https://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo/hello-world.md?plain=1) for more.
 
-<details>
-<summary>Draft a Repository Discussion</summary>
+##### Draft a Repository Discussion
 
 ```markdown
 <!--
@@ -95,10 +91,7 @@ Hello beautiful world! 🌎
 
 ```
 
-</details>
-
-<details>
-<summary>Draft a Team Post</summary>
+##### Draft a Team Post
 
 ```markdown
 <!--
@@ -112,8 +105,6 @@ Hello beautiful world! 🌎
 
 ```
 
-</details>
-
 #### Metadata
 
 | Name             | Description                                                                                                                                                                      | Required                                                 | Example                                                   |