This is a website for the Goldhirsh Foundation.
https://goldhirshfoundation.org
- How to make changes
- How to add a blog post
- How to add an image
- How to see a preview of your changes
- How to develop locally
- Handy guides
github.com/la2050/goldhirshfoundation/deployments
The website is published with GitHub Pages and the files are generated with Jekyll.
As you make changes and commit/push them to GitHub, the website will automatically update.
For example, if you edit the LA2050 page on GitHub, and then press the “Commit changes” button–you should see your changes on the LA2050 page of the website within a few minutes.
The easist way to add a blog post is to use Siteleaf. If you make a change in Siteleaf, it will appear on the staging website. (LeAnn and Jim have a Siteleaf account.)
You can also follow these steps, to add a blog post using GitHub…
-
Open the _posts folder.
-
Press the
create new filebutton: https://github.com/la2050/goldhirshfoundation/new/master/_posts -
Name the file using today‘s date (or whichever date you’d like to use as the published date) along with the name of the post. It’s best to use lowercase letters and dashes instead of spaces for your filename. For example:
2018-07-09-and-the-winners-are.markdown
- Copy and paste this text into your new post, and then change it to your liking:
---
title: Enter your title here
excerpt: This is a single paragraph of text that will appear on the blog page
https://goldhirshfoundation.org/blog/
About three to five lines of text will be best. You can put the whole excerpt on a
single line or multiple lines (like this example). Each line after the first one
should be preceded by two spaces.
author: Tara Roth
published: true
---
Your first paragraph of text can go here.
## And here’s an example of a title
To see more examples, try opening some of the other posts, or read the markdown guide:
https://guides.github.com/features/mastering-markdown/
You can also use one of the other posts as a starting point.
- Press the
Commit changesbutton
Your new blog post should appear on blog page within a few minutes.
The easist way to add an image is to use Siteleaf. If you make a change in Siteleaf, it will appear on the staging website. (LeAnn and Jim have a Siteleaf account.)
Here are more details, if you want to add an image using GitHub instead…
If you want to add an image (or any file) to the website, you can upload it to one of the folders on GitHub.
The uploads folder might be a good choice, if you’re unsure where to put a file.
Once you’ve chosen a folder, follow these steps:
-
Press the
Upload filesbutton -
Use the uploader to upload your files
-
Press the
Commit changesbutton
It’s best to use lowercase letters and dashes instead of spaces for your filename. For example: womens-march-la.jpg.
Once your file has been uploaded it be available at a web address that corresponds to the folder and filename that you chose. For example:
/uploads/womens-march-la.jpg
To use this on the website, you can create an image with markdown:
If you’d like to see how your changes will look on the website before making them public, you can work in the staging branch–a copy of the website files, that’s published at https://staging.goldhirshfoundation.org
You can make edits in the staging branch and commit them just as you would normally. They’ll automatically appear on the staging website within a few minutes.
Once you’re happy with how your changes look on the staging website, you can copy them over to the public website (the master branch) using a pull request. Here are the steps:
- Press the “new pull request” button.
https://github.com/la2050/goldhirshfoundation/pull/new/staging
-
Write a title for your pull request (this is optional).
-
Press the “create pull request” button.
-
And then, press the “merge pull request” button.
-
And lastly, press the “confirm merge” button.
If you want to see a preview of your changes while you work, you can run a Jekyll server on your local machine. Installing Ruby and Jekyll is a good place to start.
After you have Jekyll installed, you can clone this project with Git or GitHub Desktop…
git clone https://github.com/la2050/goldhirshfoundation.git
And then start running the Jekyll application like this...
jekyll serve