JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 80
  • Score
    100M100P100Q66996F
  • License MIT

CLI tool to cut markdown file in a madly comfortable way

Package Exports

  • madcut
  • madcut/plugin

Readme

🎬 MadCut License NPM version Build Status Coverage Status

CLI tool to cut markdown into peaces. Based on 🐊Putout code transformer.

Install

npm i madcut

CLI

Just run 🎬MadCut, it will read README.md and write peaces according to their headings to files. Generally names converted to kebab form: ## Hello world will be converted to file name hello-world.md.

$ madcut

API

madcut(markdown);

Infer captions to a list.

import madcut from 'madcut';
import montag from 'montag';

await madcut(montag`
    # Hello
    ## World
`);

// returns
({
    index: '# Hello\n',
    world: '## World\n',
});

cut(markdown)

Cut markdown file into a peaces list.

import {cut} from 'madcut';
import montag from 'montag';

await cut(montag`
    # Hello
    
    ## World
    
    This is the world
`);

// returns
[
    montag`
        # Hello\n\n
    `,
    montag`
        ## World
        
        This is the world\n
    `,
];

infer(markdown);

Infer captions to a list.

import {infer} from 'madcut';
import montag from 'montag';

await infer(montag`
    # Hello
    ## World
`);

// returns
['World'];

License

MIT