apeman-task-wiki
apeman task to push github wiki.
Last updated 4 years ago by okunishinishi .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install apeman-task-wiki 
SYNC missed versions from official npm registry.

apeman-task-wiki

Build Status Code Climate Code Coverage npm Version JS Standard

apeman task to push github wiki.

Running this task cause:

  1. Clone GitHub wiki project into temporary directory.
  2. Copy files from main repo in to the cloned wiki repo.
  3. Commit and push the cloned wiki repo.
  4. Cleanup the cloned wiki repo.

Installation

$ npm install apeman-task-wiki --save-dev

Usage

  1. Define a task within Apemanfile.js
  2. Call the task via apeman task command.

Apemanfile.js

/** This is an example Apemanfile to use apeman-task-wiki */

'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $tasks: {
    // Define your own task.
    'wiki:push': require('apeman-task-wiki')('./doc/wiki', {
      //Options
    })
  }
}

Then,

$ apeman task wiki:push

Signature

define(src, options) -> function

apeman task to push github wiki.

Args
Name Type Default Description
src string Source file name pattern.
options object Optional settings.
options.msg string Message for commit.
options.tmp string Tmp directory path.
options.url string Wiki url. Auto detect unless specified.

License

This software is released under the MIT License.

Links

Current Tags

  • 2.0.0                                ...           latest (4 years ago)

6 Versions

  • 2.0.0                                ...           4 years ago
  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (2)
Dev Dependencies (10)

Copyright 2014 - 2016 © taobao.org |