Skip to content

Dev-Mind/devmind-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

005bba6 · Sep 28, 2018

History

11 Commits
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018
Sep 28, 2018

Repository files navigation

Module node devmind-website

Travis status

This project is used to build the Dev-Mind websites. The aim is to use handlebars as template solution and asciidoctor.js to writes dynamic pages as a blog. Several others extensions help to generate a rss file, a sitemap file…​

Dev-Mind

Use this module

This module is made to be used in a GulpFile. You can read the gulpfile.js used to test the extensions or you can see the gulpfile used on the main Dev-Mind website (https://github.com/Dev-Mind/dev-mind.fr).

To install this module use for example with yarn

yarn add https://github.com/Dev-Mind/devmind-website.git#X.Y.Z

To import the module in your gulpfile you can use

const website = require('devmind-website')();

You can also send parameters. Below I use the default values

const WEBSITE_PARAMS = {
  path : '../../../',
  metadata : {
    rss: 'src/metadata/rss.json',
    blog: 'src/metadata/blog.json',
    html: 'src/metadata/html.json',
    sitemap: 'src/metadata/sitemap.json'
  }
};
const website = require('./index')(WEBSITE_PARAMS);

Extensions

apply-template

TODO

convert-to-blog-list

TODO

convert-to-blog-page

TODO

convert-to-html

TODO

convert-to-json

TODO

convert-to-rss

TODO

convert-to-sitemap

TODO

file-exist

TODO

files-exist

TODO

highlight-code

TODO

read-asciidoctor

TODO

read-html

TODO

read-index

TODO

Use cases

TODO

Dev & prod

TODO

Compatibility

You have to use a

  • node version >= 10.0

  • gulp >= 4.0.0

License

devmind-website is released under the MIT license.