npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

markdown-maker

v1.10.5

Published

A superset-compiler for markdown using marked

Downloads

139

Readme

markdown-maker

Mocha

A node parser for markdown variables and including of files. It is intended as a simplistic replacement for TeX documents, primarily for writing stories, D&D campaigns or other similar text based works.

Features

Currently supports the following features

  • Defining variables with #mddef<name=value> and retrieving of values with #mdvar<name>, or simply <name>
  • Including and parsing other files, preserving all defined variables, with mdinclude<filename.md>
  • Automatic Table of Contents generation with #mdmaketoc
  • HTML emitting with custom styling
  • Easy extention of custom commands, see src/commands.js for implementations
  • Usage of templates with the #mdtemplate<...> command.

Usage

Download the latest release, and write your document.

When you want to compile your document, use mdparse <file> or mdparse <dir> to produce dist/bundle.md. See below for options when compiling.

Command Line Arguments

--use-underscore (-uu):

Change the id referencing in the Table of Contents to use "_" instead of "-". Depending on your Markdown renderer of choice, this may fix ToC linking.

--verbose (-v) / --debug (-db):

Enable verbose output, which prints much more information about which tokens are found. Debug mode also logs even more information, mostly useful for debugging the parser itself.

--watch (-w):

Watch the target file or directory for changes, and recompile whenever changed.

--html:

Emit the compiled HTML to dist/bundle.html

To style the document, it is recommended to put #mdinclude<style.html> in the head of your main.md, and in style.html, put

<!-- style.html -->

<style>
    /**
     * your styles here 
     */
</style>

--allow-undef (-au):

Allow undefined variables. Instead of throwing an undefined variable error, put <VarName>. Useful for allowing infile CSS, HTML, code snippets or other situations, where the < and > symbols are used. However, this means that the variable with the same name must be undefined, so use only when needed.


See mdparse --help for all arguments and their usage.

Development

Run npm test to execute tests in test/ directory.

To build binary files for different systems, install required packages with npm install, change pkg/targets in package.json, and run npm run build.