-
Notifications
You must be signed in to change notification settings - Fork 0
/
docgen_slides-2021-02-07_reveal-slides.html
107 lines (101 loc) · 3.86 KB
/
docgen_slides-2021-02-07_reveal-slides.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="author" content="Stijn Dejongh">
<meta name="keywords" content="Markdown, generation, slidedeck, DocGen">
<title>SDDevelopment DocGen Project</title>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="https://unpkg.com/[email protected]//css/reveal.css">
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<link rel="stylesheet" href="https://unpkg.com/[email protected]//css/theme/moon.css" id="theme">
<!-- Printing and PDF exports -->
<script>
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = window.location.search.match( /print-pdf/gi ) ? 'https://unpkg.com/[email protected]//css/print/pdf.css' : 'https://unpkg.com/[email protected]//css/print/paper.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
</script>
<!--[if lt IE 9]>
<script src="https://unpkg.com/[email protected]//lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<div class="slides">
<section id="title-slide">
<h1 class="title">SDDevelopment DocGen Project</h1>
<p class="author">Stijn Dejongh</p>
</section>
<section id="need-for-documentation" class="slide level2">
<h2>Need for documentation</h2>
<ul>
<li><p>We prefer writing code</p></li>
<li><p><strong>BUT</strong> asynchronous knowledge sharing has VALUE</p></li>
<li><p>DRY principle: easier to write once then say it a lot</p></li>
</ul>
</section>
<section id="use-simple-files" class="slide level2">
<h2>Use simple files</h2>
<ul>
<li><p>Document THOUGHTS and DECISIONS, not how the code works</p></li>
<li><p>Developers like to keep documentation close to the code</p></li>
<li><p>Flat text files are great</p></li>
<li><p>Most WYSIWYG processors are slow to work with</p></li>
<li><p>LaTeX syntax is convoluted</p></li>
</ul>
</section>
<section id="docgen-stack" class="slide level2">
<h2>DocGen Stack</h2>
<ul>
<li><p>Ubuntu Linux</p></li>
<li><p>Pandoc + TexLive</p></li>
<li><p>Some template libraries</p></li>
<li><p>Some MD editor. I use NeoVim</p></li>
</ul>
</section>
<section id="automate-the-boring-stuff" class="slide level2">
<h2>Automate the boring stuff</h2>
<ul>
<li>Markdown to PDF</li>
<li>Avoid setting up entire machine</li>
<li>Can be added to build pipeline</li>
</ul>
</section>
<section id="give-it-a-go" class="slide level2">
<h2>Give it a go!</h2>
<ul>
<li><strong>Try it out, and let me know what you think!</strong></li>
</ul>
</section>
</div>
</div>
<script src="https://unpkg.com/[email protected]//lib/js/head.min.js"></script>
<script src="https://unpkg.com/[email protected]//js/reveal.js"></script>
<script>
// Full list of configuration options available at:
// https://github.com/hakimel/reveal.js#configuration
Reveal.initialize({
// Push each slide change to the browser history
history: true,
// Transition style
transition: 'cube', // none/fade/slide/convex/concave/zoom
// Optional reveal.js plugins
dependencies: [
{ src: 'https://unpkg.com/[email protected]//lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: 'https://unpkg.com/[email protected]//plugin/zoom-js/zoom.js', async: true },
{ src: 'https://unpkg.com/[email protected]//plugin/notes/notes.js', async: true }
]
});
</script>
</body>
</html>