README.md in blogdown-0.0.2 vs README.md in blogdown-0.1.0

- old
+ new

@@ -1,54 +1,55 @@ # Blogdown ## Features -* syntax highlighting -* easy to use +* Generates html from markdown files +* Syntax highlighting with coderay +* Built in server +* Simple and beautiful UI + ## Installation -Add this line to your application's Gemfile: +Run: - gem 'blogdown' - -And then execute: - - $ bundle - -Or install it yourself as: - $ gem install blogdown - -## What it does - -This gem converts markdown files to html files - - ## Usage Create a directory for your project - mkdir blogdown + $ mkdir blogdown Inside your freshly created folder create another folder "posts" - cd blogdown - mkdir posts + $ cd blogdown + $ mkdir posts -Now, put all your markdown files inside this "posts" folder, remember to use the `.md` extendion +Now, put all your markdown files inside this "posts" folder, remember to use the `.md` extension eg. `hello.md` -If you are done, and wish to build your html, for your rich text editor, -navigate to your project root directory (our case 1blogdown`), And Run +## Building html - blogdown build +If you are only interested in getting html files, navigate to the project root directory and run the following command. -A new directory "output" will be created and the respective output files(html) will be inside the folder + $ blogdown build +This will create `output` directory and dump all html files there. The naming convention is simple. +`hello.md` will produce `hello.md.html`. + +## Serving the files + +In some cases you might be interested to see what they might be like in a browser. There is a feature for you. +Just navigate to the project root and run. + + $ blongdown server + +Behing the scene, the command will build the project first, and run a webserver which will be available at `http://localhost:4567` +copy `http://localhost:4567` and paste into your browser to see the files and view them with much more options. + ## Contributing -1. Fork it ( https://github.com/[my-github-username]/blogdown/fork ) +1. Fork it ( https://github.com/gernest/blogdown/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request