README.md

Nick's Notes

This repository contains the source code for the knowledge repository hosted at notes.nickbelzer.me.

Getting started

These instructions should get you started running a local copy on your own machine.

Prerequisites

• Ruby
  • You can install it through brew (brew install ruby) on MacOS.
• Bundler
• Jekyll
  • You can install both through: gem install bundler jekyll.
• Node.js
  • Personally I manage my node versions through n. Can be installed through brew (brew install n) on MacOS.
• npm

Installation

• bundle install to install Ruby gems.
• npm ci to install npm packages listed in package-lock.json.
• npm run start or npm run dev to compile the site with development settings and run BrowserSync.

Building

• npm run build:dev to compile the site with development settings
• npm run build:production or npm run build to compile the site for production

Deploy

Use npm run build or npm run build:production.

Acknowledgements

• taylorbryant/jekyll-starter-tailwind - Base setup for the repo with TailwindCSS.