Skip to content

imjackson/jacksongpack.com

Repository files navigation

My personal website / online CV. (Site Status)

About

This site is built with plain HTML and CSS, and is hosted on Netlify. Node is used during development to run Prettier as a pre-commit hook.

Consideration was taken to make this site as fast and as energy efficient as possible. Fonts are served locally and preloaded. The fonts used are subsetted into base Latin characters. Images and markup are kept to a minimum.

Running Locally

  • Clone the repository:
git clone https://github.com/imjackson/jacksongpack.com.git

or

git clone git@github.com:imjackson/jacksongpack.com.git # if using ssh
  • Install development dependencies with npm: npm install
  • Run the site using your preferred live-server app.

Husky and Pretty-Quick are used to run Prettier as a pre-commit hook; meaning your code will be formatted each time you make a commit. You can run prettier manually with npm run lint:write.

Building Site

The build script is a simple bash script that copies necessary public files into the dist/ directory. This avoids serving development files when using a host like Netlify. If a dist/ folder is already found in the root directory, it is deleted before building. The following files or directories are copied into the dist/ directory:

  • assets/
  • css/
  • \*.html
  • LICENSE
  • robots.txt

The build script will also inject a line into the robots.txt file which points to the sitemap location (/sitemap.xml). A sitemap is not included in this repo, as it is created at build time with netlify-plugin-sitemap.

Run the script with: npm run build, or direct your host to run npm run build before deploying and ensure that the public directory is set to dist/.

Development Dependencies

Fonts

Fonts are served locally from assets/fonts.

Fonts used:

License

This repository is maintained with the GNU General Public License v3.0 (where applicable). However the following files or directories are Copyright Jackson Pack, and may not be used without permission:

  • assets/images/