# grunt-markx

> Grunt plugin for converting markdown and code into html

Latest version **0.2.0** (published 2013-11-12) · 0 weekly downloads

## Install

```sh
npm install grunt-markx
pnpm add grunt-markx
yarn add grunt-markx
bun add grunt-markx
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2013-11-12 |
| First published | 2012-11-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Greg Allen |
| Maintainers | jga |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-markx
- Repository: https://github.com/jgallen23/grunt-markx
- Issues: https://github.com/jgallen23/grunt-markx/issues
- npm.io page: https://npm.io/package/grunt-markx

## Recent versions

- 0.2.0 (latest) — 2013-11-12
- 0.1.0 — 2012-11-01

## README

# grunt-markx

> Grunt plugin for converting markdown and code into html

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-markx --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-markx');
```

## The "markx" task

### Overview
In your project's Gruntfile, add a section named `markx` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
	markx: {
		input: {
			options: {
				template: 'example/layout.html',
				data: {
					pageTitle: 'this is the page title'
				}
			},
			files: {
				'example/output.html': 'example/input.md'
			}
		}
	},
})
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

---
_Source: https://npm.io/package/grunt-markx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._