You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by uc...@apache.org on 2014/07/31 15:22:44 UTC

git commit: [Docs] Limit nesting of generated TOCs

Repository: incubator-flink
Updated Branches:
  refs/heads/master 23289d6ea -> bcf85c2a5


[Docs] Limit nesting of generated TOCs

The jekyll tocify plugin generates an HTML TOC based on the headings
of the markdown files. This commit limits the nesting of the TOC to 2,
which means that only h1 and h2 element will be taken into account.
Previously, all heading elements were used, which resulted in a very
cluttered TOC.


Project: http://git-wip-us.apache.org/repos/asf/incubator-flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-flink/commit/bcf85c2a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-flink/tree/bcf85c2a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-flink/diff/bcf85c2a

Branch: refs/heads/master
Commit: bcf85c2a50326dd3e54df223a2494dcc4f83eab5
Parents: 23289d6
Author: uce <u....@fu-berlin.de>
Authored: Thu Jul 31 15:22:10 2014 +0200
Committer: uce <u....@fu-berlin.de>
Committed: Thu Jul 31 15:22:10 2014 +0200

----------------------------------------------------------------------
 docs/_plugins/tocify.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/bcf85c2a/docs/_plugins/tocify.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/tocify.rb b/docs/_plugins/tocify.rb
index 7df0c3d..9eb6293 100644
--- a/docs/_plugins/tocify.rb
+++ b/docs/_plugins/tocify.rb
@@ -1,7 +1,7 @@
 module Jekyll
   module Tocify
     def tocify(input)
-      converter = Redcarpet::Markdown.new(Redcarpet::Render::HTML_TOC)
+      converter = Redcarpet::Markdown.new(Redcarpet::Render::HTML_TOC.new(nesting_level: 2))
       converter.render(input)
     end
   end