boxit

HTML and text file builder / collator

npm install boxit
20 downloads in the last week
40 downloads in the last month

Boxit

BoxIt is a command-line tool designed to make compiling a single HTML page (or even plain text) from multiple snippets locally a lot simpler.

NPM

Build Status stable

Why Boxit?

This project was created as a follow-up project to deckem which I started as to help with creating deck.js presentations. Deckem wasn't really the right solution though, as it was too narrow in it's focus.

By comparison, Boxit is incredibly flexible and allows you to use both local and remote resources to create static local files (suitable for offline bundling).

Creating a deck.js presentation is one potential use, but it could just as easily be used to assist with collating multiple HTML sections of a single page mobile app, or even possibly creating a CSV file.

Getting Started

The first thing you need to do is to create a configuration file that defines your project file that instructs BoxIt how to behave. A reference example has beencreated in this repository and the json configuration file from that example is shown below:

{
    "title": "Test Presentation",
    "template": "github://DamonOehlman/packing-instructions/deck.js",
    "sources": [
        "files/file1.html",
        "files/file2.md",
        "files/file3.jade",
        "files/subdir/"
    ]
}

This config file is parsed and converted into a html file (by default) with the same name as the json file. For instance, this example file is presentation.json so would be converted to presentation.html.

How it works

File Loading

To be completed.

Template Parsing

To be completed.

Defining a Template

To be completed, but take a look at the packing instructions repository for some examples. Essentially, you have a json file that defines the template and an accompanying handlebars template file that source files are passed through.

Reference

Boxer(opts)

Boxer.findConfig(target)

Boxer.isValidData(data)

Boxer._createProcessors(configFiles)

License(s)

MIT

Copyright (c) 2013 Damon Oehlman damon.oehlman@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you