This repo contains the blog of CartoDB blog.cartodb.com
CartoDB Blog uses a mix of Jekyll and Grunt tasks for development.
bundle install
npm install -g grunt-cli
npm install
grunt serve
A tab in your browser will open and direct you to http://0.0.0.0:9000
Also, you can run the blog locally as if it was on production with grunt serve:dist
To publish a post in the blog, please follow this workflow:
- Have a local copy of the repo
- Create a new branch for your new post (
git checkout -b title-of-my-post) - Commit your changes (
git commit -am 'New post: Title of my post') - Push to the branch (
git push origin title-of-my-post) - Create a new Pull Request
The Pull Request will be reviewed and commented on, and if everything is ok, merged into master, which will deploy the changes to production.
- Save your draft to the _drafts folder
- Launch
grunt drafts - After you want to publish your draft, move your post to the normal
_postsfolder
Normally the excerpts of the posts take the first paragraph of the content (it can be an image), but you can override this by placing a <!--more--!> tag in the text. The description meta of the page comes from this excerpt, unless you specifically set description: in the Front Matter.
Images can be styled so they are 940px width and have a border. Just wrap it between the next code:
- without link
<div class="wrap"><p class="wrap-border"><img src="http://" alt=""></p></div>
- with link
<div class="wrap"><p><a href="http://" class="wrap-border"><img src="http://" alt=""></a></p></div>
#### Featured images
Add layout_color: in the Front Matter.
layout_color: '/img/posts/2014-07-15-enjoy-the-best-spanish-soccer-in-san-francisco/atleti-tickets.jpg'
Add the next tags avobe and below the code to show, with the syntax to highlight (scss, sql, javascript, html, ...):
{% highlight javascript %}
...
{% endhighlight %}
Careful with the indentation and the name of the syntax
While developing related posts, i.e. --lsi option are disabled in order to not slow files regeneration. To check related posts and still make it fast just install gsl. In OSX:
brew install gsl
gem install rb-gsl
Thumbnails are auto generated with the first image in the content of each post. They can be overriden by placing thumbnail_image: in the Front Matter. We use Jekyll Thumbnail Filter for this.
grunt deploy:staging|production
You'll need a grunt-aws.json credentials file.
There's a hook set up so when pushing to master it is automatically deployed to production