site-neo/README.md

1.3 KiB

Atlas48's Neocites Archives

Welcome to the technical documentation for my Neocities page, which also contains a rudimentary static site generator cobbled together out of unix tools and Ruby scripts

License

All markup is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) license. Any runnable computer code or Sass/CSS definitions are licensed under the GNU General Public License v3.0

Specification

Dependencies

You will need the following tools to render and upload the site

Makefile

Wraps render.sh for the most part.

Makefile Options

list

Lists all components in a heading-annotated list

list-{doc,sass,dir,rest}

Lists markup files, sass files, directories, and other files respectively.

clean

Removes the out/ directory that is generated on running of render.sh.

render.sh

The primary worker script, sets up the directory structure, transpiles the markup, then the Sass, then copies the contents of in/ to out/