MD-Curcuma

The Data-Wrangler. Copys and transforms Markdown and CSV files from your Obsidian-Vault for usage in Hugo.

• This thing ist done with Typescript.
• Inspired by: /~https://github.com/accraze/split-md
• Why not golang? So you can use it easier outside the golang unsiverse.

What is in the box?

Availible Reader and Writer

1. Markdown - for Markdown Files.
2. CSV -For files with comma-separated values, where each line is a record. This is a BookBuddy App support: CSV-File conversion & Image Download.
3. XLSX - read, write and transform (upcoming).
4. Json

Availible Tasks

Markdown

1. Copying and transforming one or more Markdown files.
2. Split Markdown longform documents into several individual documents.
3. Obsidian-Links (Images and Documents), copy Files on the fly.
4. Latex-Formulas, Paragraph and Inline.
5. Frontmatter: Add, Replace, Map and Transform Values.
6. Callouts.
7. Remove Todos.
8. TODO: Take wikilinks (cross-references) into account. Footnotes Endnotes support.

Availible Mappings

1. Adopt Value - a simple pass through example.
2. ArrayJoin, ArraySplit
3. Boolean Inverse
4. Image Downloader
5. Insert Date (now)
6. Insert UUID
7. Trim Characters from String.

You can build customized transformers and Mappers for different solutions. For planned features and changes take a look into the CHANGELOG.md

Broken Link Checker

Bases on the great Linkinator, adds some features:

• Exports the result as JSON, providing a data source for Hugo
• Limit the scan to 'extern', 'intern' or scan 'all'.
• Write each scan to a different file
• have some special_excludes.

For usage refere to the broken-links-checker.test.ts

Restrictions

• It only runs in Backend, not in Browsers.
• Reading and writing is not arbitrary - (but should be).

How it works

After the redesign its quite straight forward:

flowchart
    subgraph runner
      subgraph tasks
        task-1
        task-2
        ...
      end
     reader --> tasks --> writer
    end

Loading

Important

I am currently redesigning the framework fundamentally. There is a completely new API.

Until the documentation is updated, please take a look at the (not deprecated) test and test-0-excluded folder.