Skip to content

ElijahToussaint/stevensoni

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub tag (latest SemVer) GitHub issues License GitHub stars

Stevensoni

A simple one page static site generator.

Report Bug · Request Feature · Releases

About The Project

Desktop Mobile
desktop mobile

What is a static site generator?

A static site generator is a tool that generates a full static HTML website based on raw data and a set of templates. Essentially, a static site generator automates the task of coding individual HTML pages and gets those pages ready to serve to users ahead of time.

What is a static site?

A static site consists of a series of HTML files, each one representing a physical page of a website. On static sites, each page is a separate HTML file.

Why is it called Stevensoni?

Stevensoni is the seed shrimp (Darwinula stevensoni), the most common arthropods in the fossil record with fossils being found from the early Ordovician to the present.

Built With

Features

  • Open source, AGPL License.
  • Lightweight and easy to deploy.
  • Clean, mobile-friendly interface.
  • Supports seperate sections for personal links and cryptocurrencies.
  • A webserver is started so you can preview your website in a browser.
  • Support for the Nunjucks templating engine.
  • A user interface that can add, edit, and delete information for your website.
  • Host anywhere static HTML is supported.

Installation

Install dependencies:

sudo apt install nodejs git

sudo apt install npm

Clone the git repository:

git clone https://github.com/ElijahToussaint/stevensoni

Go into the directory:

cd stevensoni

Install node packages:

npm install

Start the app on localhost:

npm start

Generate site:

npm run generate

To access the ui: The default port is 5000. The port variable can be modified in the config file.

http://localhost:{port}/

Configuration

Configuration files can be found in the config and data directories.

Refer to the example files in the config and data directories for examples.

All multimedia files referenced in the site should be stored in the public assets directory.

All configuration files should be in hjson format and saved with the .hjson extension.

Customization

The appearence of the generated site can be modified by editing the public/css/stylesheet.css file in the public directory.

Stevensoni uses Spectre for its frontend design. Learn to modify the CSS variables here.

Support / Donate

Stevensoni is free, open-source software. Donations directly support development of the project.

Crypto

  • Bitcoin (BTC): bc1qrf2f64n4znghwvaxt3mf3jr82fxw9wf83w6xtg
  • Ethereum (ETH): 0xB07b8b081BAA0d6Ad5D072A3132FfFd289bc5dAF
  • Bitcoin Cash (BCH): qqxveqvtefqx4aszn83euv7mdcd8mgtx3cr3vu85dk
  • Litecoin (LTC): LQZCnoGLKyEpqw7jpKfc1qpYN1bwLvyTcS
  • Dogecoin (DOGE): D8cBSTDAh4LXDxkHVN44Nnf3LECgTerNjx
  • Zcash (ZEC): t1YKzhroHjPwUwc5uxU7t4RP2rCt6FDo2ee
  • Dash (DASH): XfQ2kvpQBKWjiDpCUe7G4RukrQN2YvVy7Y
  • Monero (XMR): 44tUtL754iP1uM1Vet2uUqJtLNCfgDCdjFqtSjg58oUYT576G47xdzjYoRrFhUr66obzLtFuBprMjBt1YfiKy2SpAqocWS8

Contact

Code Mirrors

Packages

 
 
 

Contributors