smol
Very smol website builder
Last updated 9 months ago by mihaifm .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install smol 
SYNC missed versions from official npm registry.

Smol

Static site generator with a bare minimum set of features.

  • Generate html from markdown sources
  • Support for ejs templates
  • Page metadata (front-matter)
  • Default theme
  • Admin panel with authentication
  • Online markdown editor
  • Image upload
  • No database, everthing is file based

For a more complete feature set see smolpress.

Install

Requires node.js >= 10.0

npm install -g smol
cd blog
smol init
export SMOL_VAULT_PASSWORD=yourpassword
smol start

Alternate installation (that doesn't involve the global smol command):

git clone https://github.com/mihaifm/smol blog
cd blog
npm install
export SMOL_VAULT_PASSWORD=yourpassword
node index.js

Visit localhost:3939 to view your blog and localhost:3939/admin to manage posts.

Authentication

Smol provides a single user that is created when visiting /admin. User data is stored in a text file (data/vault.txt) which is encrypted with the password available in the SMOL_VAULT_PASSWORD environment variable.

Environment variables

  • SMOL_VAULT_PASSWORD - encryption password for the "vault" containing user data.
  • SMOL_PORT - server port. Default: 3939
  • SMOL_SRC_PATH - path to the markdown page sources. Default: source
  • SMOL_OUTPUT_PATH - path to the generated static files. Default: public
  • SMOL_DATA_PATH - path to the data folder. Default: data

Current Tags

  • 1.3.3                                ...           latest (9 months ago)

9 Versions

  • 1.3.3                                ...           9 months ago
  • 1.3.2                                ...           9 months ago
  • 1.3.1                                ...           9 months ago
  • 1.3.0                                ...           9 months ago
  • 1.2.0                                ...           9 months ago
  • 1.1.0                                ...           9 months ago
  • 1.0.0                                ...           9 months ago
  • 1.0.2                                ...           6 years ago
  • 1.0.1                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (10)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |