madcut

MadCut

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

Install

npm i madcut

CLI

Just run MadCut, it will read README.md and write pieces 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 pieces 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