CocoaPods / blog.cocoapods.org

The blog for CocoaPods
https://blog.cocoapods.org/
34 stars 38 forks source link

blog.cocoapods.org

The blog for CocoaPods

Setup

To install git submodules and grab ruby dependencies:

$ rake bootstrap

Development

To start a local server that shows all posts including drafts:

$ rake serve:drafts

This is also the default task, so just rake will do the same.


Or if you want to see the blog *without any draft posts, as the blog would look if it were to be deployed right now:

$ rake serve:published

The shared submodule is the cocoapods shared resources repo that holds shared design notes and assets.

Add a new author

Navigate to the _config.yml file. Add a nickname for you followed by your full name, twitter handle and gravatar hash.

Add a new post

Create a new file in _post directory following the format year-month-day-blog-post-title.markdown

Start the post using Jekyll's Front Matter:

---
layout: post
title:  "Blog Post Title"
author: nickname
categories: tags that are relevant
---

Use Jekyll's post_url function to link to other posts, as this provides build-time validation of links. The function takes the full post filename minus the extension.
If a link repeats several times throughout the post, use reference-style links.
Example of using both:

CDN support was first introduced in the [1.7 release][1.7] and was finalized in [1.7.2].

[1.7]: {% post_url 2019-02-22-CocoaPods-1.7.0-beta %}
[1.7.2]: {% post_url 2019-06-14-CocoaPods-1.7.2 %}

Deployment

Run rake deploy to push to site the gh-pages branch.

The _gh-pages folder (which is ignored) is used to checkout the gh-pages of this repo. rake deploy will push the built version of the site to that branch and push to the server pulling in any changes.

Drafts

Drafts are stored in the _drafts folder to leverage the drafts feature of jekyll. The rake serve task is configured to show the drafts.

License

This repository and CocoaPods are available under the MIT license.