jsmdlibmgr v0.2.0

Tiny markdown library manager

Install:

Yarn/NPM:

• yarn add jsmdlibmgr or npm i jsmdlibmgr

Manually:

1. Download start.js
2. Put start.js near your index.html

3. Include libs:

   • Using cdn:

     <script src="https://unpkg.com/jsmdlibmgr@0.2.0/dist/tinylibmgr.js"></script>

   • Locally (best):

     • download necessary files from dist/
     • put it to /js near your index.html

     Also, you able to add plugins from https://unpkg.com/jsmdlibmgr/

Usage:

Start a server:

• manually: node <path/to/>start.js
• yarn/npm run start

@index.html:

TinyLibMgr.init([options]).then(lib => lib.run());
// or
const lib = await TinyLibMgr.init([options]);
lib.run();

• create a library folder passed to libraryIndex option (default: /lib)
• create an index.md file as a library root table of contents
• add links to another files or folders as you wish
• every nested folder should include an index.md file as a table of contents for current folder (category)

Advanced:

Options:

{
  libraryIndex: '/lib', // library index folder path
  rootElementId: 'root', // ID of element to render markdown to
  syntaxHightlightPreClass: 'sourcecode', // class for source highlight <pre>
  debug: false, // debug logging
  use: {
    emoji: false, // use emoji plugin (vendor lib required)
    hljs: false // use highlight plugin (vendor lib required)
}

TODO:

• add default styling
• add windows support
• add more plugins