homepage/README.md
2021-10-17 00:05:22 +03:00

889 B

homepage

This repository holds the entire source code of my website. It has a custom static site generation system.

Building

NPM/Yarn and Node are required.

npm install
npm start

This will "build" all of the necessary html files and place them into the out folder. The out folder now contains all the files necessary for the website, so it can be served somewhere.

Structure

src/components/ - Contains reusable components.

src/env/ - Contains configuration for how the website should be laid out/where it should get data from.

src/*.page.js - Files that end in .page.js will be "built" into html files. They must export a string.

buildconfig.js - Contains various parameters that alter the build process.

out/ - All generated html files will be placed in this folder. Note that by default it contains certain static content such as the css styles.