3runoDesign/blog

HE:labs Blog

★ 1Forks 0CSSGitHub ↗Compare

Project website ↗

README

HE:labs Blog

This is the HE:labs Blog code, you can see the live blog on http://helabs.com.br/blog/.

Dependencies

To run this project you need to have:

  • Ruby 2.1.0 - You can use RVM

Setup the project

  1. Install the depedencies above

  2. Clone the project

     $ git clone [email protected]:Helabs/blog.git
    
  3. Go into the project folder

     $ cd blog
    
  4. Install the gem dependencies

     $ bundle install
    

If everything goes OK, you can now run the project!

Running the project

  1. Start the server

     $ bundle exec foreman start
    
  2. Open http://localhost:4000/blog/, don't forget to put trailing '/'.

Creating your post

  1. This create a file and the branch for your post using the rake task below.

     $ rake new_post['Title of the post']
    
  2. Write your post.

  3. Commit your changes.

     $ git add .
     $ git commit -am 'post: Title of the post'
    
  4. Push the branch.

     $ git push --set-upstream origin post/title-of-the-post
    
  5. Send a pull request by GitHub web interface.

Markdown

The syntax used by the blog is the markdown, you can take a look at this cheatsheet for more info.

Code Highlighting

Use the following syntax:

{% highlight ruby linenos %}
class Say
  def hello
    say "Hello!"
  end
end
{% endhighlight %}

Images

Save your images in /images/posts/YYYY-MM-DD/. Your image URL will look like this: /blog/images/posts/YYYY-MM-DD/.

Create a list

For create a list on your post, always use hifen (the "-"), like this:

- item1
- item2
- item3

And it will look like this:

  • item1
  • item2
  • item3

Don't use asterisk, otherwise the list will break.

Publishing a post

  1. Open the pull request's page

  2. Check if the publish date is correct on the post filename. It should be the current day. If it's wrong, ask the author to fix it.

  3. Click the "Merge pull request" button

    Merge pull request

  4. Click the "Confirm merge" button

    Confirm merge

  5. Click the "Delete branch" button

    Delete branch

  6. Wait a little bit and access the blog to see the new post

Maintainers

Made with love by HE:labs

HE:labs

This app was created and is maintained by HE:labs.

LICENSE

Blog of HE:labs and its content is licensed under an Attribution-NonCommercial-ShareAlike 3.0 Unported license.

Contributors

crystalspinellimatheusbrasbeatrizcp87mikaelcarraramergulhaoguiloyins3runoDesigndirceu-jraliismayilovthiagonzalezFlaviaFortesAnaluvieirafranciscomxsmaurogeorgealuisioazevedoeduardofiorezifgrehmisraverianeziocamposrafaelpTiuTalkthiagogabrielRafaelChefemarciojreginato

Issues