50 lines (36 loc) · 1.56 KB

Manual install

If you prefer not to use the styledown:install generator, you can install Styledown manually by making the files yourself.

Controller — Make a controller to host your styleguides.

# app/controllers/styleguides_controller.rb
class StyleguidesController < ApplicationController
  include Styledown::Rails::Controller

  styledown.root = 'docs/styleguides'
  styledown.append_template :head, 'styleguides/head'
  styledown.use_template_engine :erb, :haml
end

Routes — Add routes for your new controller.

# config/routes.rb
resource 'styleguides', only: [:show] do
  get '*page', action: :show, as: :page
end

View (optional) — Create the styleguides/head partial. This will be injected into the <head> section. Optional: you can skip this by changing the controller's styleguide.append_template options to use a different partial instead.

<!-- app/views/styleguides/_head.html.erb -->
<%= stylesheet_link_tag 'application' %>
<%= javascript_include_tag 'application' %>

Styleguides — Make your first styleguide in docs/styleguides.

 <!-- docs/styleguides/index.md -->
 # Styleguides

 These are example styleguides.

 ### buttons
 These are buttons. And since we defined :haml in `use_template_engine`,
 these haml examples will be rendered within Rails.

 ```example.haml
 %a.btn.btn-default Click me
 ```

Try it out — you should now have http://localhost:3000/styleguides. Enjoy!