Skip to content

Commit 07a96a3

Browse files
Added presentation infrastructure & liquidoc talk
* Added a Deck.js presentation about LiquiDoc for Write the Docs 2017 * Removed compiled slide deck. * Added README explaining how to build talk * Included licensing info. * Included Deck.js licensing notice. * Added a Deck.js presentation about LiquiDoc for Write the Docs 2017 * Removed compiled slide deck. * Changed '5' to 'Five' in part title * Added Gemfile for side build
1 parent 061a9d7 commit 07a96a3

File tree

114 files changed

+10254
-10
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+10254
-10
lines changed

Gemfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ source 'https://rubygems.org'
22

33
gem 'jekyll', '~> 3.1'
44
gem 'asciidoctor', '~> 1.5.0'
5+
gem 'tilt'
6+
gem 'haml'
7+
gem 'thread_safe'
58

69
group :asciidoctor_plugins do
710
gem 'asciidoctor-pdf'

README.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -257,14 +257,15 @@ book-cw: # <4>
257257
glossary.yml
258258
includes: # <7>
259259
part-directories:
260-
scripts: # <8>
261-
liquidoc.rb
260+
presentations: # <8>
261+
scripts: # <9>
262+
liquidoxify.rb
262263
publish.rb
263-
theme: # <9>
264+
theme: # <10>
264265
fonts:
265266
pdf-theme.yml
266-
Gemfile # <10>
267-
index-book.adoc # <11>
267+
Gemfile # <11>
268+
index-book.adoc # <12>
268269
----
269270

270271
<1> Global data source files, not specific to Codewriting book
@@ -274,10 +275,11 @@ index-book.adoc # <11>
274275
<5> Build configurations for the book's precompiled source files
275276
<6> Data source files for the book, for building complex content
276277
<7> Discrete content files (topics, source samples, etc)
277-
<8> The build scripts (`publish.rb` and `liquidoc.rb`)
278-
<9> Files used to style output; hopefully these will evolve to consolidate across media
279-
<10> The project's Ruby dependency collection
280-
<11> The book index (document map)
278+
<8> Source for slide decks.
279+
<9> The build scripts (`publish.rb` and `liquidoxify.rb`)
280+
<10> Files used to style output; hopefully these will evolve to consolidate across media
281+
<11> The project's Ruby dependency collection
282+
<12> The book index (document map)
281283

282284
== Legal Stuff
283285

book-cw/part-5-evolving/evolving.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Part 5: Evolving
1+
= Part Five: Evolving
22

33
[partintro]
44
--

presentations/liquidoc/Gemfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
gem 'asciidoctor', '~> 1.5.0'
2+
gem 'tilt'
3+
gem 'haml'
4+
gem 'thread_safe'

presentations/liquidoc/README.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Presentation: LiquiDoc for Complex Content
2+
3+
This directory contains tooling and content for building a Deck.js powered slide show out of AsciiDoc and image source files.
4+
5+
The content, a presentation of the free and open-source (FOSS) LiquiDoc tool for building rich docs out of semi-structured data, was written as a lightning talk to present at http://www.writethedocs.org/conf/na/2017/[Write the Docs Portland 2017].
6+
7+
LiquiDoc is a rudimentary (early alpha) Ruby command-line tool that builds documentation artifacts from sources formatted with lightweight or tagged markup.
8+
9+
== Build
10+
11+
The source files for this presentation must be compiled into an HTML/JavaScript presentation.
12+
This is done by running the Asciidoctor Ruby gem and passing it a custom set of templates for parsing AsciiDoc source to Deck.js output.
13+
14+
From the Codewriting project root directory:
15+
16+
----
17+
cd presentations/liquidoc
18+
19+
bundle install
20+
21+
bundle exec asciidoctor -T templates/haml -o liquidoc-slides.html index-talk.adoc
22+
----
23+
24+
Open `liquidoc-slides.html` in your favorite browser.
25+
26+
== Notice
27+
28+
This repo contains the link:http://imakewebthings.com/deck.js/[Deck.js framework] under the link:https://github.com/imakewebthings/deck.js[MIT License].
29+
30+
== License
31+
32+
Contents of `index-talk.adoc` file and `assets/` directory covered by Creative Commons ShareAlike 3.0 Unported.
33+
You are welcome to repurpose as you see fit, please just credit and link back to Codewriting.
115 KB
Loading
105 KB
Loading
65.2 KB
Loading
207 KB
Loading
93.2 KB
Loading

0 commit comments

Comments
 (0)