1 | apeman-tmpl-bud
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
15 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
16 |
|
17 | [bd_repo_url]: https://github.com/apeman-tmpl-labo/apeman-tmpl-bud
|
18 | [bd_travis_url]: http://travis-ci.org/apeman-tmpl-labo/apeman-tmpl-bud
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-tmpl-labo/apeman-tmpl-bud.svg?style=flat
|
20 | [bd_license_url]: https://github.com/apeman-tmpl-labo/apeman-tmpl-bud/blob/master/LICENSE
|
21 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-tmpl-labo/apeman-tmpl-bud
|
22 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-tmpl-labo/apeman-tmpl-bud.svg?style=flat
|
23 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-tmpl-labo/apeman-tmpl-bud.svg?style=flat
|
24 | [bd_gemnasium_url]: https://gemnasium.com/apeman-tmpl-labo/apeman-tmpl-bud
|
25 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-tmpl-labo/apeman-tmpl-bud.svg
|
26 | [bd_npm_url]: http://www.npmjs.org/package/apeman-tmpl-bud
|
27 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-tmpl-bud.svg?style=flat
|
28 | [bd_standard_url]: http://standardjs.com/
|
29 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | <a name="description"></a>
|
36 |
|
37 | apeman template of bud files.
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 | <a name="overview"></a>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <a name="sections"></a>
|
52 |
|
53 |
|
54 |
|
55 | <a name="section-doc-guides-01-installation-md"></a>
|
56 | Installation
|
57 | -----
|
58 |
|
59 | ```bash
|
60 | $ npm install apeman-tmpl-bud --save-dev
|
61 | ```
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 | <a name="section-doc-guides-02-usage-md"></a>
|
69 | Usage
|
70 | ---------
|
71 |
|
72 | 1. Define a tmpl within Apemanfile.js
|
73 | 2. Render templates via apeman tmpl command.
|
74 |
|
75 | **Apemanfile.js**
|
76 | ```javascript
|
77 | /** This example Apemanfile to use apeman-tmpl-bud */
|
78 |
|
79 | 'use strict'
|
80 |
|
81 | module.exports = {
|
82 | $pkg: { /* ... */ },
|
83 | $tmpls: {
|
84 | // Map file path and template.
|
85 | 'src/my-dest.txt': require('apeman-tmpl-bud')({
|
86 | // Pass rendering params
|
87 | })
|
88 | }
|
89 | }
|
90 |
|
91 | ```
|
92 |
|
93 | Then,
|
94 | ```bash
|
95 | $ apeman tmpl
|
96 | ```
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 | <a name="section-doc-guides-03-params-md"></a>
|
104 | Params
|
105 | ---------
|
106 |
|
107 | | Key | Description |
|
108 | | --- | -------- |
|
109 | | type | Template type. |
|
110 |
|
111 | #### Supported Types
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 | <a name="license"></a>
|
122 |
|
123 | License
|
124 | -------
|
125 | This software is released under the [MIT License](https://github.com/apeman-tmpl-labo/apeman-tmpl-bud/blob/master/LICENSE).
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 | <a name="links"></a>
|
132 |
|
133 | Links
|
134 | ------
|
135 |
|
136 | + [apeman](https://github.com/apeman-labo/apeman)
|
137 | + [apeman-tmpl](https://github.com/apeman-cmd-labo/apeman-tmpl)
|
138 |
|
139 |
|