ascii_binder 0.0.7 → 0.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.adoc +7 -214
- data/ascii_binder.gemspec +3 -3
- data/bin/ascii_binder +226 -0
- data/bin/asciibinder +97 -26
- data/lib/ascii_binder/helpers.rb +100 -26
- data/lib/ascii_binder/tasks/guards.rb +1 -1
- data/lib/ascii_binder/template_renderer.rb +11 -7
- data/lib/ascii_binder/version.rb +1 -1
- data/templates/.gitignore +9 -0
- data/templates/_build_cfg.yml +29 -0
- data/templates/_distro_map.yml +11 -0
- data/templates/_images/asciibinder-logo-horizontal.png +0 -0
- data/templates/_images/asciibinder_web_logo.svg +125 -0
- data/templates/_images/book_pages_bg.jpg +0 -0
- data/templates/_images/favicon.ico +0 -0
- data/templates/_images/favicon32x32.png +0 -0
- data/templates/_javascripts/.gitkeep +0 -0
- data/templates/_stylesheets/asciibinder.css +562 -0
- data/templates/_templates/_css.html.erb +3 -0
- data/templates/_templates/_nav.html.erb +31 -0
- data/templates/_templates/page.html.erb +96 -0
- data/templates/index-main.html +89 -0
- data/templates/welcome/index.adoc +14 -0
- metadata +22 -3
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<ul class="nav nav-sidebar">
|
|
2
|
+
<%- navigation.each.with_index do |topic_group, groupidx| -%>
|
|
3
|
+
<%- current_group = topic_group[:id] == group_id -%>
|
|
4
|
+
<li class="nav-header">
|
|
5
|
+
<a class="" href="#" data-toggle="collapse" data-target="#topicGroup<%= groupidx %>">
|
|
6
|
+
<span id="tgSpan<%= groupidx %>" class="fa <%= current_group ? 'fa-angle-down' : 'fa-angle-right' %>"></span><%= topic_group[:name] %>
|
|
7
|
+
</a>
|
|
8
|
+
<ul id="topicGroup<%= groupidx %>" class="collapse <%= current_group ? 'in' : '' %> list-unstyled">
|
|
9
|
+
<%- topic_group[:topics].each.with_index do |topic, topicidx| -%>
|
|
10
|
+
<%- if not topic.has_key?(:topics) -%>
|
|
11
|
+
<%- current_topic = current_group && (topic[:id] == topic_id) -%>
|
|
12
|
+
<li><a class="<%= current_topic ? ' active' : '' %>" href="<%= subtopic_shim %><%= topic[:path] %>"><%= topic[:name] %></a></li>
|
|
13
|
+
<%- else -%>
|
|
14
|
+
<%- current_subgroup = topic[:id] == subgroup_id -%>
|
|
15
|
+
<li class="nav-header">
|
|
16
|
+
<a class="" href="#" data-toggle="collapse" data-target="#topicSubGroup-<%= groupidx %>-<%= topicidx %>">
|
|
17
|
+
<span id="sgSpan-<%= groupidx %>-<%= topicidx %>" class="fa <%= current_subgroup ? 'fa-caret-down' : 'fa-caret-right' %>"></span> <%= topic[:name] %>
|
|
18
|
+
</a>
|
|
19
|
+
<ul id="topicSubGroup-<%= groupidx %>-<%= topicidx %>" class="nav-tertiary list-unstyled collapse<%= current_subgroup ? ' in' : '' %>">
|
|
20
|
+
<%- topic[:topics].each do |subtopic| -%>
|
|
21
|
+
<%- current_subtopic = current_group && current_subgroup && (subtopic[:id] == topic_id) %>
|
|
22
|
+
<li><a class="<%= current_subtopic ? ' active' : '' %>" href="<%= subtopic_shim %><%= subtopic[:path] %>"><%= subtopic[:name] %></a></li>
|
|
23
|
+
<%- end -%>
|
|
24
|
+
</ul>
|
|
25
|
+
</li>
|
|
26
|
+
<%- end -%>
|
|
27
|
+
<%- end -%>
|
|
28
|
+
</ul>
|
|
29
|
+
</li>
|
|
30
|
+
<%- end -%>
|
|
31
|
+
</ul>
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta content="IE=edge" http-equiv="X-UA-Compatible">
|
|
6
|
+
<meta content="width=device-width, initial-scale=1.0" name="viewport">
|
|
7
|
+
<title><%= distro %> <%= version %> | <%= [group_title, subgroup_title, topic_title].compact.join(' | ') %></title>
|
|
8
|
+
|
|
9
|
+
<!-- Bootstrap -->
|
|
10
|
+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
|
|
11
|
+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
|
|
12
|
+
<link href="<%= File.join(css_path, "asciibinder.css") %>" rel="stylesheet">
|
|
13
|
+
|
|
14
|
+
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
|
15
|
+
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
|
16
|
+
<!--[if lt IE 9]>
|
|
17
|
+
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
|
18
|
+
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
19
|
+
<![endif]-->
|
|
20
|
+
|
|
21
|
+
<link href="<%= File.join(images_path, "favicon32x32.png") %>" rel="shortcut icon" type="text/css">
|
|
22
|
+
<!--[if IE]><link rel="shortcut icon" href="<%= File.join(images_path, "favicon.ico") %>"><![endif]-->
|
|
23
|
+
<meta content="AsciiBinder" name="application-name">
|
|
24
|
+
<style type="text/css">
|
|
25
|
+
.navbar-brand {
|
|
26
|
+
padding-top: 5px;
|
|
27
|
+
}
|
|
28
|
+
</style>
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div class="navbar navbar-default" role="navigation">
|
|
32
|
+
<div class="container-fluid">
|
|
33
|
+
<div class="navbar-header">
|
|
34
|
+
<a class="navbar-brand" href="http://www.asciibinder.org/"><img alt="AsciiBinder" src="<%= File.join(images_path, "asciibinder-logo-horizontal.png") %>"></a>
|
|
35
|
+
</div>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
<div class="container">
|
|
39
|
+
<p class="toggle-nav visible-xs pull-left">
|
|
40
|
+
<button class="btn btn-default btn-sm" type="button" data-toggle="offcanvas">Toggle nav</button>
|
|
41
|
+
</p>
|
|
42
|
+
<ol class="breadcrumb">
|
|
43
|
+
<li class="sitename">
|
|
44
|
+
<a href="<%= site_home_path %>"><%= site_name %></a>
|
|
45
|
+
</li>
|
|
46
|
+
<li class="hidden-xs active">
|
|
47
|
+
<%= breadcrumb_root %>
|
|
48
|
+
</li>
|
|
49
|
+
<li class="hidden-xs active">
|
|
50
|
+
<%= breadcrumb_group %>
|
|
51
|
+
</li>
|
|
52
|
+
<%= breadcrumb_subgroup_block %>
|
|
53
|
+
<li class="hidden-xs active">
|
|
54
|
+
<%= breadcrumb_topic %>
|
|
55
|
+
</li>
|
|
56
|
+
</ol>
|
|
57
|
+
<div class="row row-offcanvas row-offcanvas-left">
|
|
58
|
+
<div class="col-xs-8 col-sm-3 col-md-3 sidebar sidebar-offcanvas">
|
|
59
|
+
<%= render("_templates/_nav.html.erb", :navigation => navigation, :group_id => group_id, :topic_id => topic_id, :subgroup_id => subgroup_id, :subtopic_shim => subtopic_shim) %>
|
|
60
|
+
</div>
|
|
61
|
+
<div class="col-xs-12 col-sm-9 col-md-9 main">
|
|
62
|
+
<div class="page-header">
|
|
63
|
+
<h2><%= article_title %></h2>
|
|
64
|
+
</div>
|
|
65
|
+
<%= content %>
|
|
66
|
+
</div>
|
|
67
|
+
</div>
|
|
68
|
+
</div>
|
|
69
|
+
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
|
|
70
|
+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
|
71
|
+
<!-- Latest compiled and minified JavaScript -->
|
|
72
|
+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
|
|
73
|
+
<script type="text/javascript">
|
|
74
|
+
/*<![CDATA[*/
|
|
75
|
+
$(document).ready(function() {
|
|
76
|
+
$("[id^='topicGroup']").on('show.bs.collapse', function (event) {
|
|
77
|
+
if (!($(event.target).attr('id').match(/^topicSubGroup/))) {
|
|
78
|
+
$(this).parent().find("[id^='tgSpan']").toggleClass("fa-angle-right fa-angle-down");
|
|
79
|
+
}
|
|
80
|
+
});
|
|
81
|
+
$("[id^='topicGroup']").on('hide.bs.collapse', function (event) {
|
|
82
|
+
if (!($(event.target).attr('id').match(/^topicSubGroup/))) {
|
|
83
|
+
$(this).parent().find("[id^='tgSpan']").toggleClass("fa-angle-right fa-angle-down");
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
$("[id^='topicSubGroup']").on('show.bs.collapse', function () {
|
|
87
|
+
$(this).parent().find("[id^='sgSpan']").toggleClass("fa-caret-right fa-caret-down");
|
|
88
|
+
});
|
|
89
|
+
$("[id^='topicSubGroup']").on('hide.bs.collapse', function () {
|
|
90
|
+
$(this).parent().find("[id^='sgSpan']").toggleClass("fa-caret-right fa-caret-down");
|
|
91
|
+
});
|
|
92
|
+
});
|
|
93
|
+
/*]]>*/
|
|
94
|
+
</script>
|
|
95
|
+
</body>
|
|
96
|
+
</html>
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
7
|
+
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
|
|
8
|
+
|
|
9
|
+
<title>AsciiBinder Site Template</title>
|
|
10
|
+
|
|
11
|
+
<!-- Bootstrap -->
|
|
12
|
+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
|
|
13
|
+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
|
|
14
|
+
|
|
15
|
+
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
|
16
|
+
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
|
17
|
+
<!--[if lt IE 9]>
|
|
18
|
+
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
|
19
|
+
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
20
|
+
<![endif]-->
|
|
21
|
+
</head>
|
|
22
|
+
<body>
|
|
23
|
+
<div class="container">
|
|
24
|
+
<div class="row">
|
|
25
|
+
<div class="page-header" style='background-image: url("_images/book_pages_bg.jpg"); background-position: right bottom; background-repeat: no-repeat; background-size: cover;'>
|
|
26
|
+
<img src="_images/asciibinder_web_logo.svg" class="img-responsive" />
|
|
27
|
+
</div>
|
|
28
|
+
</div>
|
|
29
|
+
<div class="row">
|
|
30
|
+
<div class="col-md-8">
|
|
31
|
+
<h4><strong>What <em>is</em> AsciiBinder?</strong></h4>
|
|
32
|
+
<p>AsciiBinder is a documentation system for people who have a lot of docs to maintain and republish on a regular basis. AsciiBinder was specifically developed to solve two problems at once:</p>
|
|
33
|
+
<ul>
|
|
34
|
+
<li>Make it easier for developers and community members to contribute documentation.</li>
|
|
35
|
+
<li>Make it easier for content managers to build and publish several variants of the same documentation.</li>
|
|
36
|
+
</ul>
|
|
37
|
+
<p> </p>
|
|
38
|
+
<h4><strong>AsciiBinder isn't for blogging.</strong></h4>
|
|
39
|
+
<p>If you are looking for a great tool for blogging where your articles are sourced in AsciiDoc, <em>this isn't it</em>. Seriously, go check out <a href="http://awestruct.org/">Awestruct</a>, which is awesome for that.</p>
|
|
40
|
+
<p> </p>
|
|
41
|
+
<h4><strong>AsciiBinder is for documenting versioned, interrelated projects.</strong></h4>
|
|
42
|
+
<p>On the other hand, if you are looking for a way to:</p>
|
|
43
|
+
<ul>
|
|
44
|
+
<li>Source your docs in AsciiDoc</li>
|
|
45
|
+
<li>Manage doc changes and doc versions with git</li>
|
|
46
|
+
<li>Have the ability to conditionalize topics and produce different <em>distributions</em> of the docs based on those conditions</li>
|
|
47
|
+
</ul>
|
|
48
|
+
<p>...then by jove, you've come to the right place.</p>
|
|
49
|
+
<p> </p>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="col-md-4">
|
|
52
|
+
<h5><strong>Installation</strong></h5>
|
|
53
|
+
<ol>
|
|
54
|
+
<li>Install Ruby</li>
|
|
55
|
+
<li><code>gem install ascii_binder</code></li>
|
|
56
|
+
</ol>
|
|
57
|
+
<p> </p>
|
|
58
|
+
<h5><strong>Reference</strong></h5>
|
|
59
|
+
<div class="list-group">
|
|
60
|
+
<a href="https://github.com/redhataccess/ascii_binder" class="list-group-item">
|
|
61
|
+
<span class="glyphicon glyphicon-eye-open" aria-hidden="true"></span>
|
|
62
|
+
<span class="sr-only">GitHub</span>
|
|
63
|
+
AsciiBinder on Github
|
|
64
|
+
</a>
|
|
65
|
+
<a href="/latest/welcome/" class="list-group-item">
|
|
66
|
+
<span class="glyphicon glyphicon-pencil" aria-hidden="true"></span>
|
|
67
|
+
<span class="sr-only">Pencil</span>
|
|
68
|
+
Latest Documentation
|
|
69
|
+
</a>
|
|
70
|
+
<a href="/latest/guides/user_guide.html" class="list-group-item">
|
|
71
|
+
<span class="glyphicon glyphicon-cog" aria-hidden="true"></span>
|
|
72
|
+
<span class="sr-only">Gear</span>
|
|
73
|
+
AsciiBinder User's Guide
|
|
74
|
+
</a>
|
|
75
|
+
<a href="#" class="list-group-item">
|
|
76
|
+
<span class="glyphicon glyphicon-wrench" aria-hidden="true"></span>
|
|
77
|
+
<span class="sr-only">Wrench</span>
|
|
78
|
+
AsciiBinder Maintainer's Guide
|
|
79
|
+
</a>
|
|
80
|
+
</div>
|
|
81
|
+
</div>
|
|
82
|
+
</div>
|
|
83
|
+
</div>
|
|
84
|
+
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
|
|
85
|
+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
|
86
|
+
<!-- Include all compiled plugins (below), or include individual files as needed -->
|
|
87
|
+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
|
|
88
|
+
</body>
|
|
89
|
+
</html>
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
= {product-title} {product-version} Documentation
|
|
2
|
+
{product-author}
|
|
3
|
+
{product-version}
|
|
4
|
+
:data-uri:
|
|
5
|
+
:icons:
|
|
6
|
+
|
|
7
|
+
Welcome to the AsciiBinder Docs Management System. This welcome page is provided as a template for the topic pages that you will create for your software project.
|
|
8
|
+
|
|
9
|
+
== Need Help?
|
|
10
|
+
* Check out the http://www.asciibinder.org/latest/welcome/[AsiiBinder documentation]
|
|
11
|
+
* Join our http://groups.google.com/group/asciibinder[mailing list]
|
|
12
|
+
* Find us on IRC at FreeNode, http://webchat.freenode.net/?randomnick=1&channels=asciibinder&uio=d4[#asciibinder] channel
|
|
13
|
+
* Open an https://github.com/redhataccess/ascii_binder/issues[issue on GitHub]
|
|
14
|
+
|
metadata
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ascii_binder
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.8
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- N. Harrison Ripps
|
|
8
|
+
- Jason Frey
|
|
8
9
|
autorequire:
|
|
9
10
|
bindir: bin
|
|
10
11
|
cert_chain: []
|
|
11
|
-
date: 2015-
|
|
12
|
+
date: 2015-10-21 00:00:00.000000000 Z
|
|
12
13
|
dependencies:
|
|
13
14
|
- !ruby/object:Gem::Dependency
|
|
14
15
|
name: bundler
|
|
@@ -223,7 +224,9 @@ dependencies:
|
|
|
223
224
|
description: Builder for multi product documention websites.
|
|
224
225
|
email:
|
|
225
226
|
- nhr@redhat.com
|
|
227
|
+
- jfrey@redhat.com
|
|
226
228
|
executables:
|
|
229
|
+
- ascii_binder
|
|
227
230
|
- asciibinder
|
|
228
231
|
extensions: []
|
|
229
232
|
extra_rdoc_files: []
|
|
@@ -235,6 +238,7 @@ files:
|
|
|
235
238
|
- README.adoc
|
|
236
239
|
- Rakefile
|
|
237
240
|
- ascii_binder.gemspec
|
|
241
|
+
- bin/ascii_binder
|
|
238
242
|
- bin/asciibinder
|
|
239
243
|
- lib/ascii_binder.rb
|
|
240
244
|
- lib/ascii_binder/helpers.rb
|
|
@@ -242,7 +246,22 @@ files:
|
|
|
242
246
|
- lib/ascii_binder/tasks/tasks.rb
|
|
243
247
|
- lib/ascii_binder/template_renderer.rb
|
|
244
248
|
- lib/ascii_binder/version.rb
|
|
245
|
-
|
|
249
|
+
- templates/.gitignore
|
|
250
|
+
- templates/_build_cfg.yml
|
|
251
|
+
- templates/_distro_map.yml
|
|
252
|
+
- templates/_images/asciibinder-logo-horizontal.png
|
|
253
|
+
- templates/_images/asciibinder_web_logo.svg
|
|
254
|
+
- templates/_images/book_pages_bg.jpg
|
|
255
|
+
- templates/_images/favicon.ico
|
|
256
|
+
- templates/_images/favicon32x32.png
|
|
257
|
+
- templates/_javascripts/.gitkeep
|
|
258
|
+
- templates/_stylesheets/asciibinder.css
|
|
259
|
+
- templates/_templates/_css.html.erb
|
|
260
|
+
- templates/_templates/_nav.html.erb
|
|
261
|
+
- templates/_templates/page.html.erb
|
|
262
|
+
- templates/index-main.html
|
|
263
|
+
- templates/welcome/index.adoc
|
|
264
|
+
homepage: http://asciibinder.org/
|
|
246
265
|
licenses:
|
|
247
266
|
- MIT
|
|
248
267
|
metadata: {}
|