blankpage

Blankpage - an easy static text content generator.

Installation

Install globally

npm install -g blankpage

Install locally

npm install blankpage

---

Usage

Basic usage involves invoking the blankpage command with a specified configuration file.

You can launch it from your terminal if globally installed:

$ blankpage website.json

Add to your package.json as an npm script:

"scripts": {
  "start": "blankpage website.json"
}

Use npx to run when locally installed:

$ npx blankpage website.json

---

Template

blankpage will look for a template.html file in the current working dir. The template should be a semi-valid index.html file. The file will be prefilled with the header, subheader and content.

The slots(placeholders) for the generated content are these:

<header>
    <h2>
      <//HEADER//>
    </h2>
    <h3>
      <//SUBHEADER//>
    </h3>
</header>
<section>
  <//CONTENT//>
</section>

Slot name	Slot value
<//HEADER//>	The value of the "header" key
<//SUBHEADER//>	The value of the "subheader" key
<//CONTENT//>	The content of the input files

---

Configuration

website.json - The configuration file, which holds the settings of the package.

Example:

{
  "title": "Website.com",
  "header": "Neat website",
  "subheader": "Javascript junkie.",
  "input": "InputDirectoryWithTextFiles",
  "inputSort": "fs|git",
  "inputFormat": "txt|md",
  "output": "OutDirForHTMLFile",
  "filename": "HTMLFileName",
  "highlight": "theme-name"
}

Configuration options:

Key	Value	Default Value
title	The <title> of the generated index file	""
header	The header of the website	""
subheader	The subheader of the website	""
input	The input directory, where the text files are located	txt
inputSort	Sorting type for the files: fs will sort by name, for example: a > b > c. git will sort by the order in which files were added to version control.	fs
inputFormat	The format of the input files. Support: md - Markdown, txt - Plain text files	txt
output	The output directory, where the index file will be generated.	dist
filename	The name of the index file.	index.html
highlight	Enable syntax highlighting (only works with md parser). Omit parameter for no syntax highlighting. Setting to 'default' will set default theme. Themes are available at https://highlightjs.org/static/demo/. Set to theme name for non-default theme.	undefined

---

Plans

1. Add possibility to pretty-print the html.
2. Create separate pages for each content element.
3. Better README
4. PERFORMANCE