Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
file-text

GitHub Action

Remark Markdown processor

v2

Remark Markdown processor

file-text

Remark Markdown processor

Markdown processor

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Remark Markdown processor

              
  uses: tj-actions/remark@v2
Learn more about this action in tj-actions/remark

Choose a version

Codacy Badge CI Update release version. Public workflows that use this action.

Ubuntu Mac OS Windows

remark

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@v1.7

Table of Contents

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
args string true --use toc --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 ${{ github.action_path }}/.remarkrc.json Remark configuration file

Example

Generate a PR each time your README.md changes

...
    steps:
      - name: Run remark cli
        uses: tj-actions/remark@v1.7
      - 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 }}

If you feel generous and want to show some extra appreciation:

Buy me a coffee

Features

And many more using an array of remarkjs plugins.

Credits

This package was created with Cookiecutter using cookiecutter-action

Report Bugs

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.