skypager-remark-collections

build a database from markdown writing

Usage no npm install needed!

<script type="module">
  import skypagerRemarkCollections from 'https://cdn.skypack.dev/skypager-remark-collections';
</script>

README

Skypager ES6 Collections

Take a collection of javascript files and use babel and esdoc to generate metadata about the files. This metadata can then be used to build an entity database with attributes about these files and the code that is in them.

This entity database can be used to power a number of different types of applications that can use metadata about the code in order to work with the code.

  • while at rest (e.g. doing static analysis, auto generating documentation),
  • while in AST form before compilation (automated code mods, UI assisted generation of code),
  • during testing (coverage)
  • at runtime (dynamic require, plugin architectures)