Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
grunt-slice-front
Advanced tools
Readme
Slices a Markdown file in segments separating a front matter in YAML, generates HTML, and applies a template to the result. Useful to generate web pages.
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-slice-front --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-slice-front');
In your project's Gruntfile, add a section named slice_front
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
slice_front: {
plain: {
options: {
markdownItOptions: {
html: true,
linkify: true
},
templateParams: {
title: "Demo"
}
},
src: "tests/demo.md",
dest: "tests/demo-plain.html"
}
}
});
Please consult Wiki.
{
// options.splitter is a regex that separates the sections of the markdown document.
splitter: /^(?:\-(?:\s*\-){2,})|(?:_(?:\s*_){2,})|(?:\*(?:\s*\*){2,})\s*$/gm,
// options.templateFile is, unsurprisingly, a path to the template file.
templateFile: path.resolve(__dirname, "../resources/template.jst"),
// options.templateOptions is a Lodash.template options object. See https://lodash.com/docs#template.
templateOptions = {},
// options.templateParams is an arbitrary hash of task-wide variables, made available to the template as params.
templateParams = {},
// options.markdownItOptions is a hash of MarkdownIt options.
markdownItOptions = {
typographer: true,
html: true
}
}
The task exposes three different variables to the template file:
page
is a hash of all the YAML variables.body
is an array of the markdown content and each item in the array a string of converted HTML.params
is a hash of the data in options.templateParams
.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.
BSD
FAQs
Slices a Markdown file in segments separating a front matter in YAML, generates HTML, and applies a template to the result. Useful to generate web pages.
The npm package grunt-slice-front receives a total of 8 weekly downloads. As such, grunt-slice-front popularity was classified as not popular.
We found that grunt-slice-front demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.