From 5904e526b913f677652ac50f1904007880c52460 Mon Sep 17 00:00:00 2001 From: Chris <85164331+noon-dawg@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:04:55 +0000 Subject: [PATCH] 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 --------- Co-authored-by: Weetbix --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7b30284..c824a91 100644 --- 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/).