Igor's Enabling Environment and Ever green notes

This blog contains my evergreen notes, and an enabling environment to interact with them. These are currently intermingled, but

• Key user features
  • Permalink
  • Table of Contents
  • Back Links
  • Search
  • No broken links
  • Select a Random Page
  • Keyboard features
  • Comments
• Key authoring features
  • Author: Markdown based editing and version control
  • Author: Permalinks
  • Author: Table of Contents
  • Author: Back Links
  • Author: Search
  • Author: No broken links
  • Author: Keyboard shortcuts
• Technical Wizardry
  • Typescript - Reduce the easy Javascript Errors
  • Cypress - E2E and Unit Testing
  • Vitest - Unit Testing
  • Useful scripts
  • Re-writing from scratch
  • Compilation workflow
  • Jekyll setup

Key user features

Permalink

Table of Contents

Back Links

Search

No broken links

• A script validates no broken links keeping everythign nice

Select a Random Page

• Click the monkey on this page!

Keyboard features

• ? - See help while in a post
• t - Toggle ToC

Comments

Not yet implemented, however a few things I tried that I disliked:

• Disquis
• Gitter
• hackmd

Something that seems good (for developers), is direct linking to the page on GitHub master so you can comment. However this isn't supported

Key authoring features

Author: Markdown based editing and version control

A Jekyll blog stored in markdown

Author: Permalinks

Standard markdown feature

Author: Table of Contents

Author: Back Links

Author: Search

Uses algolia:

• bi.sh - Build index for algolia search

Author: No broken links

I use a python script

~/gits/linqpadsnippets/python(master⚡) » ./checklinks.sh

Author: Keyboard shortcuts

Technical Wizardry

This blog also serves as a home to let me experiment with fun tech. Here's some of it:

Typescript - Reduce the easy Javascript Errors

Cypress - E2E and Unit Testing

Cypress is used for end-to-end testing and some unit testing. The tests are located in the cypress/e2e directory.

Vitest - Unit Testing

Vitest is used for unit testing TypeScript code. The tests are located in the src/__tests__ directory.

To run the tests:

# Run all tests
just js-test

# Run tests with verbose text output
just js-test-verbose-txt

# Run tests with coverage
just js-test-coverage

# Run tests with HTML report
just js-test-html

Note: All test results from CI runs are published to the test-results branch. This includes HTML reports, coverage data, and the verbose text output. The badges above link directly to these results, making it easy to access detailed test information without having to re-run the tests locally.

Useful scripts

• js.sh - Run the development server with live reload and excluding spurious Jekyll warnings
• prettier - Opinionated consistent formatting, auto run on git commit
• vim-toc-generator - Auto generate TOCs, auto run on save
• checklinks.sh- Check for broken links - Runs manaully from other repro

Re-writing from scratch

See some of my notes at [https://github.com/idvorkin/idvorkin.github.io/blob/master/_td/hack-web.md]

Compilation workflow

It's pretty complicated, rendered with excalidraw:

Jekyll setup

What a PITA

# at runtime
export LD_LIBRARY_PATH=/home/linuxbrew/.linuxbrew/lib

# at compile time
brew install rbenv libffi
brew link libffi

export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl@1.1)"                                                                                                                                             1 ↵
rbenv install  2.7.3