https://github.com/rmosolgo/developer-blog
Planning Center developer blog
https://github.com/rmosolgo/developer-blog
Last synced: 5 months ago
JSON representation
Planning Center developer blog
- Host: GitHub
- URL: https://github.com/rmosolgo/developer-blog
- Owner: rmosolgo
- Created: 2014-09-15T18:00:16.000Z (over 11 years ago)
- Default Branch: gh-pages
- Last Pushed: 2015-02-28T00:38:36.000Z (almost 11 years ago)
- Last Synced: 2024-10-10T05:36:33.112Z (over 1 year ago)
- Homepage: http://developers.planningcenteronline.com
- Size: 368 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ministry Centered Technologies
==============================
## Developer Blog
[Jekyll](http://jekyllrb.com) powers this blog.
Getting set up.
1. Clone this repo's `gh-pages` branch. `git clone https://github.com/planningcenter/developer-blog.git -b gh-pages`
2. If you're going to work on the blog itself run `bundle install`
3. To build the site locally `jekyll serve` or `jekyll serve --watch` to live reload your code.
Creating a new post.
1. Create a new branch.
2. Run `rake post:new["My Post Title"]`
3. Write
4. Push to GitHub
5. Create a pull request into the `gh-pages` branch of this repo.
6. When your pull request is merged Github pages will rebuild the site and your new post will be live.
#### The Post Format
Posts are written in [Markdown](https://daringfireball.net/projects/markdown/).
Each post file should contain a [YAML Front-matter](http://jekyllrb.com/docs/frontmatter/) header. Using `rake post:new` will pre-fill some values for you.
- `layout` - The layout to use when building the post page.
- `title` - The tile for your post.
- `date` - The date of the post.
There are some optional values you can set.
- `team` - The team this should be categorized under. `devops | mobile | web`
- `author` - Your name
- `header` - An absolute path to an image to use as a header on post pages. [example](http://developers.planningcenteronline.com/2014/05/01/core-data-at-planning-center.html)
The post file can be found in `_posts/`. The file name should be formatted as `---.md` with the title lowercased and words `-` delimited.
#### Author page
If you don't already have one, create a new author page for yourself.
Add a new file to `_authors/-.md`.
```yaml
layout: author
name: "Your Name"
image: "full link to profile image"
github: "github username"
twitter: "twitter username"
```
- `name` - Your full name. This should match the `author` attribute on posts you've written.
- `image` - Full path to profile image.
We append ``?s=200` to the end of the URL to get the size of image needed.
[Gravatar](https://en.gravatar.com/site/implement/images/) is the best for this.
You can generate a Gravatar link using `rake gravatar:link["you@example.com"]`
- `github` - Your GitHub username
- `twitter` - Your Twitter username
***
#### Preferences
Your preferences are stored on your local machine in `.defaults/prefs.json`.
Most preferences have a rake task for setting them.
- Editor
Your preferred markdown editor. [Mou](http://mouapp.com) is a pretty good one.
```
rake prefs:editor["Mou"]
```
The name of the app should be the same that would open by running `open -a ./file.md`