remark-custom-tasks

A remark plugin that adds support for custom task markers in markdown lists.

Installation

npm install remark-custom-tasks

Usage

import { remark } from 'remark'
import remarkCustomTasks from 'remark-custom-tasks'

const markdown = `
- Regular list item
- [q] Question to answer
- [x] Completed task
- [ ] Open task
- [D] Decision to make
`

async function process() {
  const file = await remark()
    .use(remarkCustomTasks)
    .process(markdown)
    
  console.log(String(file))
}

process()

Syntax

This plugin recognizes list items with markers in square brackets:

• [q] - Question
• [x] - Completed task
• [ ] - Open task
• [D] - Decision
• Any other marker between [ and ]

AST

This plugin adds marker and taskContent properties to list item nodes in the mdast that have custom markers.

Example:

// Input: - [q] What is a SPA?

// Output AST node:
{
  type: 'listItem',
  marker: 'q',
  taskContent: 'What is a SPA?'
  children: [
    {
      type: 'paragraph',
      children: [
        {
          type: 'text',
          value: '[q] What is a SPA?'
        }
      ]
    }
  ]
}

Testing

Run the automated tests:

npm test

This will run all unit tests in the test directory.

For manual testing with a sample markdown input:

npm run demo

You can also test with your own Markdown files using remark-cli:

# Using a relative path to the plugin file
./node_modules/.bin/remark path/to/your/file.md --tree-out --use=./index.js

# Or if you've linked the package
./node_modules/.bin/remark path/to/your/file.md --tree-out --use=remark-custom-tasks

License

MIT