documentation-editor 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b8c28c703d26a40895931e759db26f895b04ce4
-  data.tar.gz: be2dfdb433d3806ff42428404dfd0e902ee49265
+  metadata.gz: de3dc4291b2f0215d3e0021c5cfe95060b8f178c
+  data.tar.gz: efd354eebc831c9faf0898a5b18930bc244fea6c
 SHA512:
-  metadata.gz: 0deaaf80b2666390ea8c82aa41dd1d2a6291c307d029bff67c07a0e333a93857dd03b0f1d31e8fa10935eb1e3b54c6ac3bdf09ffb22f3eb7259a5caca1406fe8
-  data.tar.gz: 50d160d60e6172540e4bb2f9879c8f33214e98580f1085cbd4a5c3665e5a6a46a4aa596e4acb3e657902b45cd42a4de7281b267d4e0b3a287196f41fd5ddff2b
+  metadata.gz: a085cab90f82e21f8b12608797dad347b01cb3f34d808e446482f997669ab7e87fc0cb470585569207afab4e81d9b603845f086d36fa07c548ee8552a0909005
+  data.tar.gz: 61bbd321089e9b6fed435cb6b9f2e99616cdd243dfa998e834f2cc3baf336ff131d2fc9237c616023ee7edbdf40ebd532792c410340eb1b302a70a6614e66ee1

data/README.md

@@ -1,6 +1,6 @@
 # Documentation Editor
 
-[![Build Status](https://travis-ci.org/algolia/documentation-editor.png?branch=master)](https://travis-ci.org/algolia/documentation-editor) [![Gem Version](https://badge.fury.io/rb/documentaton-editor.png)](http://badge.fury.io/rb/documentation-editor)
+[![Build Status](https://travis-ci.org/algolia/documentation-editor.png?branch=master)](https://travis-ci.org/algolia/documentation-editor) [![Gem Version](https://badge.fury.io/rb/documentation-editor.svg)](http://badge.fury.io/rb/documentation-editor)
 
 This is the mountable Rails application providing the documentation editor of [algolia.com/doc](https://www.algolia.com/doc).
 
@@ -117,7 +117,7 @@ DocumentationEditor::Config.paperclip_options = {
 DocumentationEditor::Config.wrap_h1_with_sections = true
 ```
 
-## Markdown Extensions
+## Extensions
 
 #### Language conditions
 
@@ -155,6 +155,17 @@ Use `[[variable:VARIABLE]]` and specify any variables you want to display their
 This is the value of the `name` variable: [[variable:name]].
 ```
 
+#### Section Restriction
+
+```ruby
+Rails.application.routes.draw do
+  get '/doc/ruby(/:section)', :controller => 'pages', :action => 'show', slug: 'my_page'
+  mount DocumentationEditor::Engine => "/doc"
+end
+```
+
+If you're using the `wrap_h1_with_sections` option you can use the `:section` param to restrict the rendering to a specific section your page. The TOC will still contain everything. That's something you may want to use for SEO reasons.
+
 ## Usage
 
 Create your first page from the `/doc/admin` URL.

data/app/controllers/documentation_editor/pages_controller.rb

@@ -61,6 +61,7 @@ module DocumentationEditor
       @page = Page.find_by!(slug: params[:slug])
       @revision = @page.published_revision
       @options = params
+      @base_path = params[:section] ? request.path.split('/sections/').first : request.path
       render :preview
     end
 

data/app/models/documentation_editor/revision.rb

@@ -17,12 +17,16 @@ module DocumentationEditor
     def to_toc(options = {})
       roots = []
       levels = []
+      h1 = nil
       doc = parse_document(options.merge(no_wrap: true))
+      ids = id_generator(doc)
       doc.root.children.each do |child|
         next if child.type != :header
         text = child.options[:raw_text]
         text = resolve_variables(options, text)
-        item = { label: text, id: generate_id(doc, child.options[:raw_text]), children: [], level: child.options[:level] }
+        id = ids.generate_id(text)
+        h1 = id if child.options[:level] == 1
+        item = { label: text, id: id, children: [], level: child.options[:level], h1: h1 }
         while !levels.empty? && levels.last[:level] >= child.options[:level]
           levels.pop
         end
@@ -47,14 +51,20 @@ module DocumentationEditor
       if !options[:no_wrap] && DocumentationEditor::Config.wrap_h1_with_sections
         sections = []
         current_section = []
+        h1 = nil
+        ids = id_generator(doc)
+        keep = options[:section].nil?
         doc.root.children.each do |child|
           if child.type == :header && child.options[:level] == 1 && !current_section.select { |c| c.type != :blank }.empty?
-            sections << current_section
+            sections << current_section if keep
             current_section = []
+            keep = options[:section].nil? || options[:section] == ids.generate_id(resolve_variables(options, child.options[:raw_text]))
           end
           current_section << child
         end
-        sections << current_section unless current_section.select { |c| c.type != :blank }.empty?
+        if !current_section.select { |c| c.type != :blank }.empty? && keep
+          sections << current_section
+        end
         doc.root.children = sections.map do |nested_sections|
           section = Kramdown::Element.new(:html_element, 'section')
           section.children = nested_sections
@@ -88,9 +98,8 @@ module DocumentationEditor
       end.compact
     end
 
-    def generate_id(doc, str)
-      @html_converter ||= Kramdown::Converter::Html.send(:new, doc.root, {auto_id_prefix: ''})
-      @html_converter.generate_id(str)
+    def id_generator(doc)
+       Kramdown::Converter::Html.send(:new, doc.root, {auto_id_prefix: ''})
     end
 
     def resolve_variables(options, text)

data/app/views/documentation_editor/pages/_menu_items.html.haml

@@ -1,6 +1,6 @@
 %ul.nav
   - menu_items.each do |menu|
     %li
-      = link_to menu[:label], "##{menu[:id]}"
+      = link_to menu[:label], "#{menu[:h1] == params[:section] ? '' : @base_path}##{menu[:id]}"
       - if menu[:children].size > 0
         = render partial: 'menu_items', object: menu[:children]

data/app/views/documentation_editor/pages/preview.html.haml

@@ -13,4 +13,4 @@
         Edit
   - cache("page-#{id}-content") do
     = find_and_preserve do
-      = @revision.to_html(@options).html_safe
+      = @revision.to_html(@options.merge(section: params[:section])).html_safe

data/config/routes.rb

@@ -16,5 +16,6 @@ DocumentationEditor::Engine.routes.draw do
     get '/:id/versions', :controller => 'pages', :action => 'versions'
   end
 
+  get '/:slug/sections/:section', as: :section, :controller => 'pages', :action => 'show', constraints: { slug: /.*/ }
   get '/:slug', as: :page, :controller => 'pages', :action => 'show', constraints: { slug: /.*/ }
 end

data/lib/documentation_editor/version.rb

@@ -1,3 +1,3 @@
 module DocumentationEditor
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-editor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Algolia Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Mountable Rails application providing an extended Markdown documentation