Skip to content
/ md Public

tools for refactoring flat-file markdown knowledge bases

Notifications You must be signed in to change notification settings

freder/md

Repository files navigation

run

  • requirements:
    • ag
    • gnu sed
node src/index.js test-data
yarn run vis

mission

  • building composable pieces of functionality for working with markdown files
  • enabling more advanced workflows, while dealing with flat files only
  • tying it together in a vscode extension

ideas

  • data:
    • represent everything as a graph
      • inter-document links
      • documents themselves
  • flat file wiki:
    • links
    • backlinks
    • find broken links
    • tags
      • file-level (frontmatter)
      • per section
    • frontmatter
    • refactoring:
      • updating links, when file gets renamed
      • updating links, when directory gets renamed / moved
      • extracting section of a file to new file, and inserting a link to new file
      • rename / replace (frontmatter) tags
    • visualization
      • basic graph visualiztion
      • make nodes 'pinnable' (to be able to mix manual and automatic layout)
      • zoom / pan
    • versioning (using git): either automatic or manually
    • static site generator?
  • todo lists:
  • vscode plugin
    • wiki
      • graph view
      • editor
        • navigating links
        • link preview
      • side bar:
        • tags list
        • backlinks (with context)
      • commands:
        • (fuzzy) insert tag
        • insert links (with autocomplete)
        • refactor directory structure (s.th. like dired)
        • extract selection to new file
    • todo lists
      • custom "perspectives" (filtered views)

About

tools for refactoring flat-file markdown knowledge bases

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published