Add info on supported formats (#367)

* Add info on supported formats * Add '.markdown' file extension * Specify markup languages instead of extensions * Add suggestion from review Co-authored-by: Weetbix <[email protected]> --------- Co-authored-by: Weetbix <[email protected]>
Rebilly · Dec 11, 2024 · 5904e52 · 5904e52
1 parent 3eba69d
commit 5904e52
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -101,6 +101,8 @@ To view metrics from previous commits in a pull request:
 
 ### Example workflow
 
+This workflow reports readability metrics for `.md` files in your pull requests. For information, see [Supported markup languages](#supported-markup-languages).
+
 ```yaml
 name: Report readability
 
@@ -155,6 +157,14 @@ For example: `yarn run:local:report ./test-data/old ./test-data/new`
     1. Click "Publish release".
 1. The release is published to the Marketplace, and a [workflow automatically](./.github/workflows/update-tags-post-release.yml) updates the major and minor tags.
 
+## Supported markup languages
+
+Lexi supports the following markup languages: Markdown, Markdoc, and MDX.
+
+To configure the file formats, update the `glob` input in the workflow file. For more information, see [Example workflow](#example-workflow).
+
+Example: To report on `.md` and `.mdx` files, use: `glob: '**/*.{md,mdx}'`.
+
 ## Playground
 
 To experiment with this tool in your web browser, and get real-time readability metric data as you edit a Markdown file, try out the [playground](https://rebilly.github.io/lexi/).