Giter Site home page Giter Site logo

stat-bang's Introduction

#stat! Tool to handle markdown/html/etc for a personal website. Minimizing (1) distance from content (md) to publishing (html) and (2) maintenance/overhead.

#usage

npm install stat-bang

Then:

var statBang = require('stat-bang');
statBang.start(80);

##API

###One folder

Here's a principle that this project goes by: your public folder is your src folder.

###Directory structure

joesul.li
	node_modules
		stat-bang
	server.js
	van
		content
			readme
				index.md
	template.html

Now, visiting http://joesul.li/van/content/readme will serve index.md, rendered to html and inserted into template.html

###Example + Templating

Markdown is a great way to compose in HTML-land, but it's not the whole shebang. So, when the site is rendered, it looks for the nearest template.html ancestor and injects the markdown into it. Check it out:

/content
	/hello
		index.md
		template.html

index.md looks like:

#hi

template.html looks like:

<html>
	<!-- content -->
</html>

So,

node server.js &
cat http://joesul.li/van/content/hello

>	<html>
>	<h1>hi</h1>
>	</html>

###That's it

Ok, that's enough to get started!

stat-bang's People

Contributors

itsjoesullivan avatar

Watchers

 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.