Roamdown parses your Markdown files and looks for [[wiki-links]]. Using the [[wiki-links]] it creates a Markdown file containing all references to the link as well as a snippet of the surrounding sentence to provide context to the link, I call these created files "tag files" since they bring together all content from a specific "tag" or "category".
The basic functionality is stolen heavily inspired from Roam Research. I started using Roam and liked the idea, however, I really disliked the writing experience. If you're like me and would prefer to write in your IDE but would like the grouping of related notes that Roam provides then this should do the trick.
Roamdown has been designed to be used as a binary, the preferred use is to run:
$ npx roamdown
| Argument | Description | Default |
|---|---|---|
| --tagDirectory | The directory where your tag files will be generated | /tags |
| --entryDirectory | The directory that Roamdown will look in to find your notes | /entries |
FAQs
Roamify your Markdown files
The npm package roamdown receives a total of 0 weekly downloads. As such, roamdown popularity was classified as not popular.
We found that roamdown demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.