Skip to content
Browse files

filter/wiki: Add examples

  • Loading branch information...
1 parent 0b0f1d7 commit 8e0e057fc6a5ab3b02f249a1a94814178491b02c @icy icy committed
Showing with 10 additions and 0 deletions.
  1. +10 −0 lib/filters/wiki_filter.rb
View
10 lib/filters/wiki_filter.rb
@@ -16,6 +16,16 @@
# used as title: it will be transformed to the camelized form
# by splitting the original `id` by the underscore (_).
#
+# @example:
+# Absolute path
+# [[/vn/author-guide]]
+# [[/doc/git/gitconfig]]
+# [[blog:~huy:Ibus_and_Qt Configure Ibus for Qt applications]]
+#
+# Relative path ([[foobar]] is equivalent to [[/doc/foobar]])
+# [[git/gitconfig]]
+# [[git:gitconfig Git Configuration]]
+#
# @return : HTML output
#
class WikiFilter < Nanoc::Filter

0 comments on commit 8e0e057

Please sign in to comment.
Something went wrong with that request. Please try again.