Giter VIP home page Giter VIP logo

gulp-static-site's Introduction

Build static sites with gulp

This is how it works

$ npm install gulp gulp-static-site

Then put this in your gulpfile

var gulp = require('gulp');
var static_site = require('gulp-static-site');

var paths = {
	sources: ['contents/**','templates/**'],
	stylesheets: ['css/**']
};

gulp.task('site', function () {
	return gulp.src('contents/**/*.md')
		.pipe(static_site())
		.pipe(gulp.dest('build/'))
});

gulp.task('css', function () {
	return gulp.src('css/*.css')
		.pipe(gulp.dest('build/css'));
});

gulp.task('default', ['site','css'], function () {
	gulp.watch(paths.sources, ['site']);
	gulp.watch(paths.stylesheets, ['css']);
});

Example JADE template templates/default.jade:

doctype html
html
	head
		link(rel='stylesheet', href='http://yui.yahooapis.com/pure/0.4.2/pure-min.css')
		meta(http-equiv='content-type', content='text/html; charset=UTF-8')
	body
		div.pure-g-r#main
			div.pure-u-1-5
				p Menu
				ul
					each node in page.tree.nodes
						if node.leaf
							li
								a(href=node.leaf.href)= node.leaf.shortName
			div.pure-u-4-5
				!= page.contents

Now we need some markdown files

mkdir contents/
echo "hello from *foo*" >> contents/foo.md
echo "bye from `bar`" >> contents/bar.md
echo "welcome to my site" >> contents/index.md

Gulp that business:

gulp

[12:32:28] Using gulpfile /tmp/test/gulpfile.js
[12:32:28] Starting 'site'...
[12:32:28] Starting 'css'...
[12:32:28] Finished 'css' after 4.56 ms
[12:32:28] File tree
.
├── bar.html
├── foo.html
└── index.html

[12:32:28] loading template: templates/default.jade
[12:32:28] loading template: templates/default.jade
[12:32:28] loading template: templates/default.jade
[12:32:28] compiled template: templates/default.jade
[12:32:28] rendering [default] "bar.html"
[12:32:28] compiled template: templates/default.jade
[12:32:28] rendering [default] "foo.html"
[12:32:28] compiled template: templates/default.jade
[12:32:28] rendering [default] "index.html"
[12:32:28] gulp-size: total 1.75 kB
[12:32:28] Finished 'site' after 191 ms
[12:32:28] Starting 'default'...
[12:32:28] Finished 'default' after 12 ms

Open your file:

open build/index.html      # OSX
xdg-open build/index.html  # Linux

More info

For now, have a look at the source for gulp-static-site and the Tree object you are operating on gulp-filetree/tree.js.

gulp-static-site's People

Contributors

ivanbrykov avatar wires avatar

Watchers

 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.