GitHub Action
Remark Markdown processor
v3
Latest version
Want a cool Table of Contents for your markdown and also auto sync changes each time you make edits using this action enables the best of both worlds.
...
steps:
- uses: actions/checkout@v2
- name: Run remark cli
uses: tj-actions/remark@v3| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| args | string | true | "--output" |
remark cli options. |
| files | string | true | "README.md" |
List of input markdown files |
| plugins | string | true | "remark-toc" |
List of remarkjs plugins. |
| rc_path | string | false | ".remarkrc.json" |
Remark configuration file |
Generate a PR each time your README.md changes
...
steps:
- name: Run remark cli
uses: tj-actions/remark@v3
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v6
id: verify_changed_files
with:
files: |
README.md
- name: Create Pull Request
if: steps.verify_changed_files.outputs.files_changed == 'true'
uses: peter-evans/create-pull-request@v3
with:
base: "main"
title: "Updated README.md"
branch: "chore/update-readme"
commit-message: "Updated README.md"
body: "Updated README.md"
token: ${{ github.token }}
- Free software: MIT license
If you feel generous and want to show some extra appreciation:
- Format Markdown (remark-cli)
- Automatically add links to headings in Markdown (remark-autolink-headings)
- Lint Markdown (remark-lint)
- Highlight code blocks (remark-highlight)
- Math support for Markdown (remark-math)
- Generate a Tables of Contents (remark-toc)
And many more using an array of remarkjs plugins.
This package was created with Cookiecutter using cookiecutter-action
Report bugs at https://github.com/tj-actions/remark/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your workflow that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.