accraze / split-md

:wavy_dash: Split a Markdown file into smaller files

split-md

NodeJS CLI that splits a Markdown file into smaller files based on a given delimiter. It's basically str.split(pattern) for .md files.

Install

$ npm install split-md

Useage

To use the CLI, type split-md followed by it's args:

• readPath (path to larger .md file)
• pattern (string)
• cleanName (string): do you want to remove anything from the pattern?
• writePath (path to where smaller files should be created)
• limit (optionally limit the number of files created)
• hasCounter (optionally have the outputted files names be numbered)

Example

$ split-md 'tests/testdata.md' '### v' '###' '' 10 true

In the above example we are reading in tests/testdata.md. Our delimiter is whenever we see a line start with the pattern ### v. We want to use this line for our new markdown file's name, however we want to remove the ### by setting it as the cleanName variable. Next, we are setting the writePath to our current working directory by giving an empty string as this variable. Also note that we are setting our limit to only create 10 files before exiting. Lastly, we have true to show that we want the file names to be ordered.

License:

MIT License 2016-2018 © Andy Craze & contributors

split-md's Issues

Invalid path and filename in Windows

Firstly, thanks for the utility it helped me split my large MD files (and learn a bit about Node JS).

I'm posting my solution because I have never done a pull request before.

My MD file has headings like this (note the embedded ':' and '/')

#### AAA-BBB-1100: Some Title / Other Text

My split-md args were:

cli.args[0]="F:/a/b/c/markdownfile.md";
cli.args[1]="#### ";
cli.args[2]="####";
cli.args[3]="F:/a/b/c/";

So after Line 28

title="F:/a/b/c/AAA-BBB-1100: Some Title / Other Text"

The title/path is still ok at this point.
but after Line 29

title="F/a/b/c/AAA-BBB-1100:Some Title / Other Text.md"

The first ':' is removed making the drive field invalid. Remaining ':' are not removed because title.replace() only replaces the first occurrence. The same happens with the space ' ' replacement.
Anothe problem is that the '/' in the ""filename" is not removed also making it an invalid path.

I replaced these two lines...

split-md/src/splitter.js

Lines 28 to 29 in 495101e

	title = writePath + array[i].replace(cleanName, "").trim()
	title = title.replace(":", "").replace(" ", "") + ".md"

With these 3 lines...

      title = array[i].replace(cleanName, "").trim()
      title = sanitize(title, {replacement: "-"});
      title = writePath + title + ".md"; 

The writePath is only added after the title is cleaned otherwise it messes up the path.
I used the sanitize-filename library.

const sanitize = require('sanitize-filename');

p.s. I prefer leaving the spaces in the filename and replace illegal characters with a dash. '-'

'split-md': command not found

Hello, I'm excited to use this package. I tried to install, and it seems to have gone well:

drive$ npm i split-md

up to date, audited 15 packages in 773ms

1 package is looking for funding
  run `npm fund` for details

found 0 vulnerabilities

But then I tried to use the script in the fashion you mention:

split-md 'Letters.md' '### v' '###' '' 10 true

And I got this:

-bash: split-md: command not found

Any idea what might be going on? Thanks!

Fix coverage badge in README

For some reason the coverage badge isn't working anymore.