https://github.com/bashbaugh/chsphys.com
The website for Centaurus High School Physics Club. Made with Jekyll
https://github.com/bashbaugh/chsphys.com
Last synced: 4 months ago
JSON representation
The website for Centaurus High School Physics Club. Made with Jekyll
- Host: GitHub
- URL: https://github.com/bashbaugh/chsphys.com
- Owner: bashbaugh
- Created: 2020-06-17T19:15:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-06T14:19:39.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:53:05.044Z (about 1 year ago)
- Language: HTML
- Homepage: https://chsphys.com/
- Size: 17.7 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CHSPhysics-Website
The website for the Centaurus Physics Club. Built with Jekyll, HTML, and CSS. [chsphys.com](https://chsphys.com/)
### Build Instructions
Follow these instructions to compile the Jekyll project into a static website
1. Install Ruby and ruby-bundler: `sudo apt install ruby-full ruby-bundler build-essential zlib1g-dev`
2. Install Jekyll and dependencies with `source ./scripts/install`
3. You can serve the site locally for development with `source ./scripts/serve`. The site will be visible at `localhost:3000`
3. Build the site with `source ./scripts/build`. The compiled static site will be in the `_site` folder.
### Projects collection
The `_projects_collection` folder contains a markdown file with metadata, a description, and content for each of our projects. Each project in `_projects_collection` is rendered as a card and pop-up at `/projects`
##### Project yaml front matter fields
| Key | Value |
|------|---------|
| title | The name of the project|
| link | (optional, url) If this is set, the title of the project description will be converted to a link to this address.
| hash | (string, no spaces) The name which will be shown in the project url. For example, with the hash "someproject" the URL will be `/projects#someproject` |
| image | The image URL to be displayed on the project card |
| when | (string) The time frame of the project, such as "Fall 2020"|
| date_added | (date; YY-MM-DD) This should be the date the project was started or added to the collection. This is only used to order the projects, from most recent to oldest. |
| summary | Summary of project to be displayed on project card |
| visible | optional - if set to false, the project will not be shown |
The content of each project file should be markdown.
### Layouts
+ **content** - this is the default layout for markdown content. Contents are markdownified, centered and justified.
+ Disable justification with `no_justify: true` in front matter.
+ Set `title` to add a header title to page and set tab title.
+ Set the `subnav` mapping to add a sidebar with anchor links to headings on the page, like this:
```yaml
subnav:
- title: Section 1
- heading: section-1
```
+ Set `contact_classes` with space seperated classes for content div
+ **default** - Plain HTML with navbar and footer