Skip to content

Commit

Permalink
better generated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Érik Guittière authored and Érik Guittière committed Jan 23, 2017
1 parent d9e7dfc commit 44587ad
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 30 deletions.
30 changes: 15 additions & 15 deletions generators/app/templates/pug/pages/index.pug
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,33 @@ block content

## Development Team

**Lead Developer**
* **Lead Developer**
<%= author_name %> - <<%= author_email %>>

**Contributors**

* **Contributors**
## Build Tools & Preprocessors

Scaffolded with [generator-rkgttr](https://www.npmjs.com/package/generator-rkgttr).

**[SASS](http://sass-lang.com/guide)**
* **[SASS](http://sass-lang.com/guide)**
An extension of CSS that adds power and elegance to the basic language. It allows to use variables, nested rules, mixins, inline imports, and more.

**[Babel](https://babeljs.io/)**
* **[Babel](https://babeljs.io/)**
Babel is a JavaScript transpiler that allows you to use EcmaScript2015 today. Among other things.

**[Rollup](http://rollupjs.org)**
* **[Rollup](http://rollupjs.org)**
Rollup is a next-generation JavaScript module bundler. Author your app or library using ES2015 modules, then efficiently bundle them up into a single file for use in browsers and Node.js – even if you use advanced features like bindings and cycles.

**[Gulp](http://gulpjs.com/)**
* **[Gulp](http://gulpjs.com/)**
Automates tasks such as minification, concatenation, compression, compilation, browser refreshing etc.

<% if(usePug){ %>**[Pug](https://pugjs.org/api/getting-started.html)**
* <% if(usePug){ %>**[Pug](https://pugjs.org/api/getting-started.html)**
Pug is a terse language for writing HTML templates.

* Produces HTML
* Supports dynamic code
* Supports reusability (DRY)<%} else { %>**[Assemble](http://assemble.io/)**
* Produces HTML
* Supports dynamic code
* Supports reusability (DRY)<%} else { %>**[Assemble](http://assemble.io/)**
Assemble is a static site generator for writing HTML templates using Handlebars.
<%} %>

Expand Down Expand Up @@ -68,13 +68,13 @@ block content

## Important Files

`gulpfile.babel.js`
* `gulpfile.babel.js`
Configuration of Gulp tasks.

`package.json`
* `package.json`
Configuration of nodejs dependencies.

`README.md`
* `README.md`
This file, which contains documentation related to the project.

## JavaScript Libraries
Expand All @@ -87,7 +87,7 @@ block content
yarn
```

Then
Then:

```sh
gulp
Expand Down
29 changes: 15 additions & 14 deletions generators/app/templates/templates/pages/index.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,33 @@ description:

## Development Team

**Lead Developer**
* **Lead Developer**
<%= author_name %> - <<%= author_email %>>

**Contributors**
* **Contributors**

## Build Tools & Preprocessors

Scaffolded with [generator-rkgttr](https://www.npmjs.com/package/generator-rkgttr).

**[SASS](http://sass-lang.com/guide)**
* **[SASS](http://sass-lang.com/guide)**
An extension of CSS that adds power and elegance to the basic language. It allows to use variables, nested rules, mixins, inline imports, and more.

**[Babel](https://babeljs.io/)**
* **[Babel](https://babeljs.io/)**
Babel is a JavaScript transpiler that allows you to use EcmaScript2015 today. Among other things.

**[Rollup](http://rollupjs.org)**
* **[Rollup](http://rollupjs.org)**
Rollup is a next-generation JavaScript module bundler. Author your app or library using ES2015 modules, then efficiently bundle them up into a single file for use in browsers and Node.js – even if you use advanced features like bindings and cycles.

**[Gulp](http://gulpjs.com/)**
* **[Gulp](http://gulpjs.com/)**
Automates tasks such as minification, concatenation, compression, compilation, browser refreshing etc.

<% if(usePug){ %>**[Pug](https://pugjs.org/api/getting-started.html)**
* <% if(usePug){ %>**[Pug](https://pugjs.org/api/getting-started.html)**
Pug is a terse language for writing HTML templates.

* Produces HTML
* Supports dynamic code
* Supports reusability (DRY)<%} else { %>**[Assemble](http://assemble.io/)**
* Produces HTML
* Supports dynamic code
* Supports reusability (DRY)<%} else { %>**[Assemble](http://assemble.io/)**
Assemble is a static site generator for writing HTML templates using Handlebars.
<%} %>

Expand Down Expand Up @@ -70,13 +70,13 @@ Assemble is a static site generator for writing HTML templates using Handlebars.

## Important Files

`gulpfile.babel.js`
* `gulpfile.babel.js`
Configuration of Gulp tasks.

`package.json`
* `package.json`
Configuration of nodejs dependencies.

`README.md`
* `README.md`
This file, which contains documentation related to the project.

## JavaScript Libraries
Expand All @@ -89,7 +89,7 @@ Document any additional JS libraries here.
yarn
```

Then
Then:

```sh
gulp
Expand All @@ -106,4 +106,5 @@ The content of `<%= name %>` root directory (except `node_modules`, and `build`)
## License

MIT © <%= author_name %>

{{/markdown}}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-rkgttr",
"version": "1.1.5",
"version": "1.1.6",
"description": "Static website generator using gulp, rollup, babel, es6, scss, pug or assemble",
"homepage": "",
"author": {
Expand Down

0 comments on commit 44587ad

Please sign in to comment.