Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 3.25 KB

README.md

File metadata and controls

55 lines (38 loc) · 3.25 KB

Izzy's Personal Website ✨

Always a work in progress™️

Development

Built with Jekyll & Github Pages.

  1. Clone the repo: git clone https://github.com/izzygomez/izzygomez.github.io
  2. Install local pre-commit hooks: pre-commit install
    • This assumes pre-commit is installed; can install via pip, but I prefer a brew install.
  3. Run local server & view at localhost:4000: jekyll s
  4. To test on mobile devices (inspo) with ngrok: ngrok http http://localhost:4000

Auto-formatting

This repo uses pre-commit to automatically format and lint files before they are committed. The formatting is powered by prettier, with support for Liquid Jekyll templates using the @shopify/prettier-plugin-liquid plugin. See .pre-commit-config.yaml & prettier.config.js for configuration notes & details.

Setup pre-commit per install instructions above. If at any point you'd like to run pre-commit against all files, run:

pre-commit run --all-files --verbose

To skip pre-commit checks for a single commit:

git commit -n/--no-verify

To clean out cached pre-commit files:

pre-commit clean

Note that package.json is included in order to power GitHub Actions workflows (TODO implement), but it is not necessary for local development.

TODOs

  • Add "quotes" section to footer
    • see _data/quotes.yml & docs here
    • consider adding quotes from old Wordpress site
  • Cleanup subdir's here & either delete them or link to them in some capacity on landing page.
  • Create bookshelf/ (a la https://patrickcollison.com/bookshelf).
  • Add some explanation of directory layout here in README.
  • Add a section to this README (or possibly blog post?) detailing how this website & email server is setup (mailgun, namecheap, github pages, cloudflare, etc).
  • Re-engineer redirects/. Specifically, change it so that it's just r/, & make it so that each new endpoint created doesn't require a whole new folder to be created. i.e. I'd like to be able to easily add a new line in some file like new_endpoint: "some_new_endpoint.com" & izzygomez.com/r/new_endpoint should automatically work.
  • If I start writing blog posts again, consider using the Shiori theme (note: learned of this theme via kalzumeus.com).
  • Implement Github Actions to mirror local auto formatting.
  • Use this last modified plugin on posts.

Notes