The website for the Sunview Luncheonette in Greenpoint, Brooklyn.
Built using Jekyll, uses Netlify CMS.
Most of the site's content is events taking place at the Sunview. These events are
Jekyll posts and live in the _posts/ directory.
Jekyll requires that post files use the following naming convention: YEAR-MONTH-DATE-title.md
Posts automatically appear in the following places:
- On the events page (
/events) - In the list of upcoming events on the homepage (assuming the event's date has not yet passed)
Some posts also appear in the top grid of content on the homepage if tagged correctly. (See Adding Content to the Homepage Grid below)
In addition to Jekyll's predefined variables, posts also use the following front matter variables:
| Variable | Usage |
|---|---|
subtitle |
Appears underneath post title on post pages, if included. |
main_image |
Main "cover" image used for posts. This is used for a post "preview" on the homepage. The images path is already configured, so only the filename is needed here ("slscr-6.jpg") |
event_date |
Date the event is happening |
homepage_position |
Number included here determines where the post will appear in the homepage grid |
None of these variables are required.
The only category that has any special meaning at this point is SLSCR. All posts tagged
with SLSCR will appear on the SLSCR page (/slscr).
Jekyll pages are used for any type of content
that is not an event happening at the Sunview. E.g. Contact page, information
about the 607 CSA, the tool library. If you want to add something to the site
and it's not tied to a specific date, just put it in the _pages/ directory.
Pages use the following front matter variables:
| Variable | Usage |
|---|---|
subtitle |
Appears underneath page title if included. |
main_image |
Main "cover" image used for the page. Appears on pages and for the page "preview" on the homepage. Only the filename is needed ("607-csa.jpg") |
homepage_position |
Number determines where the page preview will appear in the homepage grid |
Images in the _images/ directory are a custom Jekyll collection. These are
only used in the homepage grid, where they are interspersed with preview of posts
and pages.
Images use the following front matter variables:
| Variable | Usage |
|---|---|
image |
Image file |
image_description |
Adds a caption to the image |
homepage_position |
Number determines where the image will appear in the homepage grid |
Any document in the site can be added to the homepage grid: posts (events), pages, or images.
To include content in the homepage grid, add a homepage_position to the document's
front matter.
To remove content from the homepage grid, just remove the homepage_position
variable.
Sunview uses Netlify as a CMS for editing content. You can add and edit posts, pages, and images via the CMS.
To use the CMS:
- You need to have a Github account (Netlify uses this for authentication).
- You must be added to the Lunchonette team on Netlify.
- Visit
/admin- you'll be prompted to sign in using Github. - Once you've signed in, you should see the CMS Dashboard.
git clone git@github.com:luncheonette/the-sunview.git- Install ruby 3.2.2 (using your version manager of choice)
bundle installto install dependencies
bundle installto make sure you have the latest dependencies.bundle exec jekyll serveto run Jekyll locally- Point your browser to
localhost:4000
- The app is deployed using
netlify - Any changes to the
masterbranch will trigger a new deploy - If the ruby or bundle versions change, you may need to update
netlify.tomlwith the new versions
- Jekyll Documentation
- Netlify Documentation
- kramdown documentation (this is the superset of Markdown we are using for generating markup)