m10rten / markdown-includes

Multiple markdown utility tags to use inside markdown with this markdown-includes compiler.

Hi there 👋

Contact
Twitter (X) 🐦	@mrvdlei
LinkedIn 🎓	@mvdlei
E-Mail 📧	[email protected]
Github	@m10rten
Skyline 🌃	@m10rten

markdown-includes's Issues

`#` in links will be taken as menu item

Once used a [link](#link) it will be included in the menu, which obviously is not the expected behaviour.

Configuration file

In sight of #17 Goal V2, having a config file is really nice: not needing to put in the parameters every time you run the command.

ofcourse, every parameter given will overwrite the config.

the order will then be:
system defaults < config file < cli parameters < file overwrites: &|menu 4 for example.

Non valid file will not throw error

Implementing the new glob package caused validation of files to be left out.

This needs to be done before hand: validate if the path is an actual string with ext (when no wildcard)

Ignore certain files or folders

when using wildcards, you might start compiling some files you do not need compiled.

introducing the ignore files feature.

set it in your config or cli command like so: --ignore dist,node_modules,build and these will not be compiled.

Glob ify the include tag to use wildcard patterns.

With the introduction of glob in mdi, the include tag did not change.

Altering this can be breaking when not tested toroughly.

Table creation

&|table data.json should make a table based on the data and keys in the json, can only be 1 layer deep due to table being one dimensional.

Table with keys, following the results of each value in the array.

Multiple wildcard paths not working

when using mdi examples/**/*-index.md,examples/**/*-file.md will stop the proces and not build any other build files

`\` breaks output

examples\file.md instead examples/file.md breaks the directory creation.

Multiple files or folder compiling.

To make use of multiple compiled files, you now have to run it for each file.
instead, run it on examples/* or just on --folder examples.
Even mdi file1.md,file2.md should work fine.

every file should then be compiled to the outdir: --out-dir or default out

noComments in config not working

Implement testing framework: Jest

To ensure quality of this package, tests are required.

• To be made inside root folder: tests.

• Implement dev deps: jest & @types/jest.

• Setup unit tests for all features.

Bug: `example/**/index.md` does not work yet, same for `example/*.md`

This way you cant specify what files from what folder should be compiled, making it nearly impossible to narrow down 1 set of files without file1.md,file2.md,file3.md etc.

`?` breaks menu

When including a ? in your title, this will not work with the output generated because question marks are not supported.
Therefor they need to be trimmed.

✨ auto generated menu/content-pages.

Include is what it does, but it should include all 1,2,3 headers and combine them into a menu.

should be included like so:

&|menu

or similar, with the &| prefix

Goal V2

Goal for the v2.0.0 is to have it ready to use within node apps outside cli applications.

This means a complete overhaul of the project.

NTH: 🔚 Custom extensions

To easily use the wildcard, implement the ext like so:
./*.i.md or ./* --ext i.md

NTH/Bug: Custom id in menu

Markdown allows for custom heading id's, therefor linking to a heading within the menu can be incorrectly applied.

This looks like:
# title {#custom-id}

This is always 1 string and therefor can be stripped easily by checking if there is a {#} in the title, then removing the specialchars leaving the id.

NTH: Footnote tag

Easily implement a footnote by just adding the footnote tag following the string that should be in the footnote.

The tag looks like: &|footnote This is a footnote and will be placed at the bottom.

For ease of use it will now be implemented where the footnote is always the last element of a line so all followed is in the footnote.

In the future this might be resolved by using some sort of closing tag: |&

Output:
Here's a simple footnote. &|footnote This is the first footnote.

Example will output:

Here's a simple footnote. [^1]

[^1]: This is the first footnote.

Multi line footnotes must be supported.

Changes in config not applied due to running message

When changing the config mid session, these changes cannot be applied, so give message to user.

⚡ Remove comments to compile option.

include &|no_comments somewhere in a file, and all comments in that file will not be taken into the output.

NTH: Table key selection

Not all data in your JSON file is usefull or ready-to-display, filter the keys you want to display in the table.
! No exceptions !

NTH: Line/Word/Char count

&|count somewhere in your fileand it will count all above lines.
&|words somewhere in your file and it will count all above words.
&|chars somewhere in your file and it will count all above characters.