The website for the Open Cleveland Brigade
If you are tasked with writing posts for the site blog, follow these instructions:
What you'll need:
- a github account with access to the opencleveland github organization. (ask @skorasaurus for this)
To create a new post:
- go to http://prose.io/#opencleveland/opencleveland.github.io/tree/master/_posts/blog
- if the page asks you to "authorize with github", click the authorize button note: ensure you are signed in with your github account
- create a new blog post by clicking the "new file" button
- you'll be taken to a page where you can create your new blog post
- once you're done writing your blog post using markdown, click the "publish" button to the right of the formatting options. This changes "published: false" to "published: true" in the metadata. The published setting must be set to true to make the file appear on the blog.
There are various controls for formatting text, links and creating images:
To add an image:
- click on the add image button.
- click "selecting one".
- pick a file on your local computer.
- in the "image url" field, ensure to change the url from something like "_posts/blog/yourimagename.jpg" to "images/blog/yourimagename.jpg" this is changing the path of the image to be images/blog/ rather then _posts/blog. !this is important, as the image will not work if this is not done!
- add in alt text for the image. alt text is important for user's that browse by websites using text readers.
- the blog master page itself is in /blog/. This page grabs Markdown files (.md) from /_posts/blog/ and turns them into blog posts based on the filename.
- each blog post gets its own file in /_posts/blog/. The filename should begin with the blog entry's date in YYY-MM-DD format. The prose.io page linked above automatically does this.
Running the Site Locally on Your Computer
To run the site locally on your own computer (most helpful for previewing your own changes), you will need Jekyll installed (click here for Jekyll installation instructions.)
Fork and clone the repository, then run the following command in the root directory of the repo:
jekyll serve --watch which will watch for changes to files.
Your computer should now be serving your local copy of the site at:
Submitting a Pull Request
- Fork the project.
- Create a topic branch.
- Implement your feature or bug fix.
- Commit and push your changes.
- Submit a pull request.