From 7e50dd8f527decd19b09670c9dba8aa8e27583d2 Mon Sep 17 00:00:00 2001 From: Philip Gai Date: Thu, 2 Dec 2021 06:35:51 +0000 Subject: [PATCH] Update docs --- README.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4ea8f5c..c03c849 100644 --- 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
  1. It is recommened to include the final `/` in the path
  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] | -
-Example announcement-drafter.yml +Example announcement-drafter.yml: -```markdown +```yml watch_folders: - docs/team-posts/ ``` -
- ### 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. -
-Draft a Repository Discussion +##### Draft a Repository Discussion ```markdown