static-dodo
v1.1.0
Published
A simple Static Site Generator CLI
Downloads
11
Readme
static-dodo
This Static Site Generator (SSG) command-line tool generates html files from text or markdown files.
A single .txt or .md file can be used as input.
A folder containing .txt or .md files can also be used as input.
All the html files will be created inside a new ./dist folder in the current directory. If a ./dist folder already exists, the folder's content will be replaced with the html files created by static-dodo.
The fist line of the text will be used as the html title and will be placed inside of a <h1> tag.
A custom CSS stylesheet can be specified by using the option -s or --stylesheet.
Requirements
Requirements to install and run:
Installation
To install the static-dodo command line tool, use:
npm install -g static-dodoThis will allow you to use static-dodo from anywhere in your system.
Usage
Using a single file as input:
static-dodo --input file.txt
static-dodo --input file.md
static-dodo -i "File name with spaces.txt"Using a folder as input:
static-dodo -i folder-name
static-dodo --input "Folder name with spaces"Adding a stylesheet:
static-dodo -i [file|folder] -s [CSS Stylesheet URL]
static-dodo -i [file|folder] --stylesheet [CSS Stylesheet URL]Using JSON file:
static-dodo -c path-to-file.json
static-dodo --config path-to-file.jsonJSON Configuration
You can use a JSON configuration file to pass options to static-dodo.
The JSON file can include the options input and stylesheet.
These options will override the ones passed in the command.
The input option in the JSON is required.
Example JSON file configuration-file.json:
{
"input": "sample-file.txt",
"stylesheet": "https://cdn.jsdelivr.net/npm/water.css@2/out/water.css"
}Example Input
Dodo-Facts.txt
DODO Facts
The dodo (Raphus cucullatus) is an extinct flightless bird that was endemic to
the island of Mauritius, east of Madagascar in the Indian Ocean.
The first recorded mention of the dodo was by Dutch sailors in 1598.Example Output
./dist/Dodo-Facts.html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>DODO Facts</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<h1>DODO Facts</h1>
<p>
The dodo (Raphus cucullatus) is an extinct flightless bird that was
endemic to the island of Mauritius, east of Madagascar in the Indian
Ocean.
</p>
<p>The first recorded mention of the dodo was by Dutch sailors in 1598.</p>
</body>
</html>Built With
- Yargs - Used for command line arguments
- Markdown-it - Used for Markdown support
- Highlight.js - Use for Markdown code highlight support
Author
- Francesco Menghi - Profile
License
This project is licensed under the MIT License