What not to do
- Do not rename the repo as apiaryio.github.io
Steps to create a blog post
- Clone the repo: https://github.com/apiaryio/apiaryio.github.com
- Create a new branch and add file under the
_postsfolder using the naming convention:
yyyy-mm-dd-name-of-blog.md(you can use the rake command below)
- Add images under the
imagesfolder and make them either .png or .jpeg format. The width of the image should be 640px. If you have images you can use the rake command below for creating an image directory.
- Add your details in the _config.yml file to be configured as an author.
- Run jekyll to see the file locally on localhost:4000 with
- Commit your file and get it reviewed by other team members by sending pull requests
- After reviewing, oncall person will merge the pull request
Running server using Docker
If you don't want to set up Ruby ecosystem, you can preview all posts using Docker:
./docker/build.shto build the
The docker image only needs to be rebuilt if the dependencies change.
(if you don't have bundler yet, start by running
sudo gem install bundler)
$ bundle install
To start a local server that shows all posts including drafts:
$ rake serve
The server will automatically recompile all the changes you make to text files, except for
_config.yml. In order to see changes to
_config.yml, you need to restart the server manually.
There are some rake commands that can be used for creating post files and image directories.
rake post['Hello World']
Create Post with Image Directory
If your post has images, you can specify
:with_images in the rake command and it will create an empty directory inside the
rake post['Hello World',:with_images]
rake image_dir['Hello World']
The server directly references Apiary website production stylesheet. In order to change this to
https://static.apiary.dev:9000 for development purposes, edit the
static variable in
_config.yml. Make sure not to commit this to Github. Also, make sure your CSS changes are deployed on Apiary before pushing blog changes to Github.