Ninja Parading Musically
Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

metamagical-markdown

0.1.0 • Public • Published

Meta:Magical Markdown

NPM version Licence Stability: Stable

Compiles Markdown files to JS modules annotated with Meta:Magical.

Example

Write your Markdown file, and optionally add meta-data using an YAML document:

---
category: Tutorials
---
 
# Heading
 
Text goes here

Compile it:

metamagical-markdown file.md

Get:

module.exports = {
  [Symbol.for('@@meta:magical')] = {
    category: 'Tutorials',
    name: 'Heading',
    documentation: '# Heading\n\nText goes here'
  }
};

Installing

The only supported way to install the transform plugin is through npm.

NOTE If you don't have npm yet, you'll need to install Node.js. All newer versions (4+) of Node come with npm.

$ npm install metamagical-markdown

Support

If you think you've found a bug in the project, or want to voice your frustration about using it (maybe the documentation isn't clear enough? Maybe it takes too much effort to use?), feel free to open a new issue in the Github issue tracker.

Pull Requests are welcome. By submitting a Pull Request you agree with releasing your code under the MIT licence.

You can join the Gitter Channel for quick support. You may also contact the author directly through email, or Twitter.

Note that all interactions in this project are subject to Origami Tower's Code of Conduct.

Licence

Meta:Magical is copyright (c) Quildreen Motta 2016, and released under the MIT licence. See the LICENCE file in this repository for detailed information.

Keywords

none

Install

npm i metamagical-markdown

DownloadsWeekly Downloads

2

Version

0.1.0

License

MIT

Last publish

Collaborators

  • avatar