Giter Site home page Giter Site logo

doc-util's Introduction

doc-util

Amaze UI Markdown docs parsing util.

Usage

'use strict';

var gulp = require('gulp');
var $ = require('gulp-load-plugins')();
var markJSON = require('markit-json');
var docUtil = require('amazeui-doc-util');

gulp.task('markdoc', function(){
  return gulp.src('./test/test.md')
    .pipe(markJSON(docUtil.markedOptions))
    .pipe(docUtil.applyTemplate())
    .pipe($.rename(function(file) {
      file.extname = '.html';
    }))
    .pipe(gulp.dest('./dist'));
});

.markedOptions

marked options for Amaze UI docs.

.applyTemplate(tpl, data)

  • tpl: Handlebars template, default is default.hbs.
  • data: data pass to tpl.

In default tpl, you can set:

{
  head: '', // code insert to HTML <head>
  footer: '', // code insert before HTML </body>
  pluginTitle: '',
  pluginDesc: '',
}

Custom data will extend with markJSON()'s result and pass to template.

doc-util's People

Contributors

minwe avatar

Watchers

James Cloos avatar keimon avatar 烂笔头 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.