0.0.1 • Published 7 years ago

fitp v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
7 years ago

Fill In The Page

Fitp is a barebones static page generator with one task only, fill in the page. This project is aimed at those with at least minor knowledge about html, css, and markdown, that want a very minimal setup. The system is build ontop of node.js and is easy to install via npm.js. The program will take the html files look for references to other html or mardown files and fill those in the pages. As well as copy it together with other files over in the .build folder.

Installation

  1. Install node.js and npm.js
  2. Run
npm install fitp -g

Commands

Run 'fitp -h' or see below.

Usage:                          fitp [options]
Options:
  -h, -help                     command options
  -b <path>, -build <path>      initiates build using data in path directory
  -v, -version                  semantic version

How to

Reference other html or markdown files by putting their relative path files between two pairs of braces. Any directories or files that start with a dot will be ignored and not included in the build process, unless explicitly referenced by an included html file. This is usful for making sure your raw markdown files do not get copied over but do get included in the build.

<html>
	{{head.html}}
	<body>
		<article>
			{{.articles/introduction.md}}
		</article>
	</body>
</html>

In the example above the head.html will also be copied over in the build folder, but the .articles folder will not. For an additional and more detailed example please see the example folder located in the repository.

License

MIT

Contribute

If you have any ideas or see any issues feel free to start a discussion at the issues section.