Skip to content

Commit

Permalink
Add reStructuredText example
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Oct 22, 2024
1 parent 18ca075 commit 96b1c3d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ jobs:
> [!TIP]
> If you're using a markup format other than Markdown, you may need to install
> an external parser.
>
> To use it with AsciiDoc, for example, add the following step to your workflow
> before calling `vale-action`:
> an external parser before calling `vale-action`:
>
> ```yaml
> # For AsciiDoc users:
> - name: Install Asciidoctor
> run: sudo apt-get install -y asciidoctor
>
> # For reStructuredText users:
> - name: Install docutils
> run: sudo sudo apt-get install -y docutils
> ```
>
> See the [Vale documentation][2] for more information.
Expand Down

0 comments on commit 96b1c3d

Please sign in to comment.