Website for the Silicomedy 硅谷脱口秀

The Website is deployed to GitHub pages and is served at ggtkx.org.

This project works with Ruby 3.3+ and Jekyll 4.2.0. The site is statically generated with Jekyll.

Getting started

1. Install Ruby dependencies

   bundle install

2. Serve the site locally

   bundle exec jekyll serve

   Open http://localhost:4000 in your browser.

3. (Optional) Set up for contributing — install pre-commit and npm deps so hooks and linting work:

   brew install pre-commit   # or: pip install pre-commit
   pre-commit install
   npm install

Contributing

This repo uses pre-commit hooks to run checks on each commit (see .pre-commit-config.yaml). One of the hooks runs ESLint for JavaScript (config: .eslintrc.json, Google JavaScript Style Guide). Install pre-commit and npm dependencies as in step 3 of Getting started above.

Data organization:

• _data/comedians.json stores information about each comedian in this club. It is updated automatically to sync up with a Google Sheet.
• _data/friends.yml stores links to our friends.
• pages/ contains Markdown documents for each page.

Other technical details:

• pull-sheet/ hosts the mechanism that updates _data/comedians.json from the roster.
• sidenotes.js is a pure-JavaScript plugin that puts .footnotes into #sidebar, aligning each piece of note at their corresponding superscript.

References

Ming has written several articles detailing the engineering aspects of this club:

• How Engineers Build A Comedy Club - Part I: The Website
• How Engineers Build A Comedy Club - Part II: Comedian Data
• How Engineers Build A Comedy Club - Part III: Videos and Subtitles

The first 2 articles are most relevant to this repo.

Acknowledgements

This website uses:

• these icons from freeicons.io:

  • YouTube icon by Raj Dev on freeicons.io.
  • Bilibili icon by Anu Rocks
  • LinkedIn icon by Muhammad Haq

• the Serif theme by Robert Austin.

• illustrations from the artwork collection, unDraw, by Katerina Limpitsouni.

License

The MIT License (MIT).