Commit 6dc25b24 authored by ak's avatar ak
Browse files

Merge branch 'master' into dev

parents 265f144d 722df497
*.code-workspace
.vscode/*
__pycache__/*
*pycache*
.tableofcontents.json
.config.yml
ak/*
......
......@@ -6,7 +6,7 @@ Pykyll is a command line tool written in Python that mimiks Jekyll in its result
> The best software is the one in which you see everything on first glance
>
> ––– Freaky Spider
> ––– A certain freaky spider
# Command Line View & More
......
Subproject commit aa3a7bdb5572b0ab4126589fcf3cc83cc953e9c6
Subproject commit 9157d1dae4e669135eca16423bd5fb178cf46c50
......@@ -2,7 +2,7 @@
author: ak
check: true
description: Extended Documentation and Examples for Pykyll
edit: 2021-Mar-06 15:31
edit: 2021-Mar-12 21:50
html: true
index: /home/ak/git/pykyll/ak/index.md
subtitle: Extended Documentation and Examples
......
......@@ -46,7 +46,7 @@ As Pykyll comes as a no-JS website, i.e. without any client side scripting, usin
#### HTML5 Video
<video width="560" height="315" controls>
<video width="100%" controls>
<source src="https://cloud.harmlos.info/index.php/s/MZFPQf8Pk7g3xZp/download" type="video/ogg">
</video>
......
......@@ -45,7 +45,7 @@ As Pykyll comes as a no-JS website, i.e. without any client side scripting, usin
#### HTML5 Video
<video width="560" height="315" controls>
<video width="100%" controls>
<source src="https://cloud.harmlos.info/index.php/s/MZFPQf8Pk7g3xZp/download" type="video/ogg">
</video>
......@@ -62,4 +62,4 @@ Here the video is stored in a NextCloud instance. How to:
</video>
```
---
\ No newline at end of file
---
......@@ -2,7 +2,7 @@
author: ak
check: true
description: Integrating to the project management stack
edit: 2021-Mar-10 12:38
edit: 2021-Mar-12 21:50
html: true
subtitle: How-to for Pykyll
title: Taskwarrior Integration
......
......@@ -28,7 +28,7 @@ in case you are using Gitlab just
and edit it accordingly. If Gitlab Pages has been correctly set up and the runner executes successfully your project documentation will appear on-line once you have:
- Installed the pykyll submodule
- Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from `htmlout`, which holds your documentation web site be the only folder touched by Pykyll
- Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from `htmlout`, which holds your documentation web site and will in addition to the folders you are creating from within the software be the only folder ever touched by Pykyll.
- Run a [c] Concise Check from Pykylls [c] Check Menu to build up a Table of Contents
- Edit your software documentation with your favourite text editor. Tip: Can be set in Pykyll. In this way the last edited time stamp tag in the topics frontmatter will be updated
- Change the `type` frontmatter tag from `topic` to `post` for a flat hierarchy. Leave it as `topic` and add some posts to provide a manual, where the topics are the chapters
......
......@@ -2,7 +2,7 @@
author: ak
check: true
description: How to manage your software documentation with Pykyll
edit: 2021-Mar-06 20:43
edit: 2021-Mar-12 21:52
html: true
index: /home/ak/git/pykyll/ak/tenical_information/index.md
subtitle: How-to with Pykyll
......@@ -32,7 +32,7 @@ in case you are using Gitlab just
and edit it accordingly. If Gitlab Pages has been correctly set up and the runner executes successfully your project documentation will appear on-line once you have:
- Installed the pykyll submodule
- Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from `htmlout`, which holds your documentation web site be the only folder touched by Pykyll
- Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from `htmlout`, which holds your documentation web site and will in addition to the folders you are creating from within the software be the only folder ever touched by Pykyll.
- Run a [c] Concise Check from Pykylls [c] Check Menu to build up a Table of Contents
- Edit your software documentation with your favourite text editor. Tip: Can be set in Pykyll. In this way the last edited time stamp tag in the topics frontmatter will be updated
- Change the `type` frontmatter tag from `topic` to `post` for a flat hierarchy. Leave it as `topic` and add some posts to provide a manual, where the topics are the chapters
......
......@@ -7,7 +7,7 @@
customize.talk
You may start by de-uncustomizing the topic of your talk. Is that even a thing?
Edit: -->
<title>ἐπῐφᾰ́νειᾰ</title>
<title></title>
<noscript>
</noscript>
......@@ -41,42 +41,11 @@
<div class="reveal">
<div class="slides">
<!-- HERELobby -->
<section>
<p>You may choose</p>
<h2>If</h2>
<p>you are not interested in customizing the look & feel of the presentation then do click <a href="#/#begin">here</a>.</p>
<h2>Else</h2>
<p>you may be interested in customizing the look & feel of the presentation or just want to go with the flow, i.e. watch and interact with the hypertextual programmed intro sequence as intended. Do click <a onclick="Reveal.next()">here</a>.</p>
</section>
<section data-background="cyber/documentation/cube_subraum.svg" id="cube" data-autoslide="1000">
<p class="fragment fade-out" data-fragment-index="0" data-autoslide="3000">kindly brought to you by</p>
<h1 class="fragment fade-in-then-out" data-fragment-index="0" data-autoslide="3000">C3PB e.V.</h1>
<p class="fragment fade-down" data-fragment-index="1" data-autoslide="10000">
Alas! The desktop cube <br>
<a href="?transition=none#/cube">None</a> -
<a href="?transition=fade#/cube">Fade</a> -
<a href="?transition=slide#/cube">Slide</a> -
<a href="?transition=convex#/cube">Convex</a> -
<a href="?transition=concave#/cube">Concave</a> -
<a href="?transition=zoom#/cube">Zoom</a>
</p>
<p class="fragment fade-up" data-fragment-index="1"><a href="#/#brb">BRB</a> OR GOTO <a href="#/#customizedthemes">THEMES</a></p>
</section>
<section data-background="cyber/documentation/cube_subraum.svg" id="brb">
<p class="fragment fade-out" data-autoslide="1000" data-autoslide-index="2">"FREE PRESS" for BIG PICTURE</p>
<!-- Reload without using the cache: true -->
<div class="fragment grow" data-autoslide="1000" data-autoslide-index="1">
<a onclick="window.location.reload(true);">
<div class="button fragment shrink" data-autoslide="1000">DONT<br>PRESS</div>
</a>
</div>
<h3 class="fragment fade-up" onclick="openFullscreen();" data-autoslide="6000">BIG RED BUTTON</h3>
<p>GOTO <a href="#/#lobby">Lobby</a> OR Almost <a href="#/#end">THE END</a></p>
</section>
<!--- Edit: Title slide -->
<section data-background="cyber/documentation/cube_subraum.svg" id="lobby">
<h3><a class="fragment fade-down" data-fragment-index="1" id="twice" data-autoslide="1000" onclick='document.getElementById("twice").innerHTML = "FULL SCREEN VIEW:";'>επιφανεια </a><span class="fragment fade-right" data-autoslide="12000" data-fragment-index="2"> <p class="button" onclick='openFullscreen(); Reveal.toggleAutoSlide(true); Reveal.next()'>FREE<br>PRESS</p></span></h3>
<h3><a class="fragment fade-down" data-fragment-index="1" id="twice" data-autoslide="1000" onclick='document.getElementById("twice").innerHTML = "FULL SCREEN VIEW:";'>επιφανεια </a><span class="fragment fade-right" data-autoslide="12000" data-fragment-index="2"> <p class="button" onclick='openFullscreen(); Reveal.toggleAutoSlide(true); Reveal.next()'>BIG<br>PIC</p></span></h3>
<p class="fragment fade-up" data-fragment-index="0" data-autoslide="1000"><a onclick='Reveal.toggleAutoSlide(true); document.getElementById("twice").innerHTML = "Press 4 Big Picture:";'><img class="plain" id="explainsitself" src="cyber/documentation/projectIcon.png"></a></span></p>
<p><a href="#/#begin">JUMP TO START</a></p>
</section>
<!-- Edit: Theme selection -->
<section data-background="cyber/documentation/cube_subraum.svg" id="customizedthemes" data-autoslide="1000">
......@@ -99,7 +68,7 @@
<a href="#" onclick="document.getElementById('theme').setAttribute('href','cyber/css/deelight.css'); return false;">Deelight</a> -
<a href="#" onclick="document.getElementById('theme').setAttribute('href','cyber/css/hackoer.css'); return false;">Hackör</a>
</p>
<p class="fragment fade-up" data-fragment-index="1">GOTO <a href="#/#brb">BRB</a>, <a href="#/#lobby">LOBBY</a>, <a href="#/#cube">CUBE</a> OR <a href="#/#end">JUMP</a> the queue</p>
<p class="fragment fade-up" data-fragment-index="1">GOTO <a href="#/#lobby">LOBBY</a> OR <a href="#/#end">JUMP</a> the queue</p>
</section>
<!-- MARKDOWN IMPORT SECTION -->
<section id="begin"
......@@ -124,7 +93,7 @@
<section>
<section id="credits" data-background="https://cloud.c3pb.de/s/wPGaWp4SPGCA86i/preview">
<h1 class="fragment fade-down" data-autoslide="2500" data-fragment-index="1">
<a href="https://git.c3pb.de/ak/epiphaneia" data-preview-link="false">hold</a>
<a href="https://git.c3pb.de/ak/epiphaneia" data-preview-link="false"><img src="https://ak.pages.c3pb.de/epiphaneia/cyber/documentation/fork.svg" width="33%"></a>
</h1>
<p class="fragment fade-in-then-out" data-autoslide="5000" data-fragment-index="2">&uarr; your own &darr;</p>
<h2>επιφανεια</h2>
......@@ -136,17 +105,12 @@
<section data-background="https://cloud.c3pb.de/s/wPGaWp4SPGCA86i/preview" data-autoslide="2500">
<p class="fragment fade-in-then-semi-out">a word by no sponsor</p>
<div class="fragment fade-up" data-autoslide="30000">
<a href="#lobby"><h1>Generic</h1>
<a href="#lobby"><h1>Live long</h1>
<p>επιφανεια</p>
<h1>Message</h1>
<h1>& prop her</h1>
</a>
</div>
</section>
<section data-background-iframe="https://writer.c3pb.de/s/BkBlhMPd8#Quickstart" data-background-interactive data-autoslide="2500">
<p class="fragment fade-out" data-fragment-index="3">Documentation Shared Makes Good Software Even Better</p>
<h1 class="fragment fade-in-then-out" data-fragment-index="0">Read IT</h1>
<h1 class="fragment fade-in-then-out" data-fragment-index="2">Write IT</h1>
</section>
</section>
</div>
</div>
......@@ -172,12 +136,10 @@
<li>to trust the domain <a href="">c3pb.de</a> to have at least tried & push IT over boundaries</li>
</ul>
<div >
<a href="index.txt">
<a href="index.md">
<div class="button">NUKE<br>IT NOW</div>
</a>
</div>
<p>straigt up <a href="https://en.wikipedia.org/wiki/Fu"></a> to un-<a href="https://en.wikipedia.org/wiki/Fu"></a> the way - kindly brought to you by</p>
<a href="https://c3pb.de/pages/impressum.html"><h1>C3PB e. V.</h1></a>
</section>
</div>
</div>
......
......@@ -31,6 +31,7 @@ hash: true,
history: true,
transitionSpeed: 'slow',
transition: 'fade',
loop: true,
dependencies: [
{ src: 'cyber/revealjs/plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'cyber/revealjs/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
......
# Example <!-- .element -->
## presentation
## blah
## foo
- minimal
- ephemeral
- bar
- baz
Note:
Some note there
......@@ -14,13 +14,11 @@ Some note there
Test
Note:
yan
note
---
Note:
ayan
---
Rest
End
\ No newline at end of file
Note:
note
\ No newline at end of file
......@@ -123,7 +123,7 @@ How to work with pictures and embedds
<p>Just look into <code>./examples/picture_test/index.md</code> to get the picture, e.g. <a href="https://git.c3pb.de/ak/pykyll/-/blob/master/examples/picture_test/index.md">here</a>.</p>
<p>As Pykyll comes as a no-JS website, i.e. without any client side scripting, using the HTML5 Video Tag seems the better option. This is not meant to be a video portal after all.</p>
<h4 id="html5-video">HTML5 Video</h4>
<video width="560" height="315" controls>
<video width="100%" controls>
<source src="https://cloud.harmlos.info/index.php/s/MZFPQf8Pk7g3xZp/download" type="video/ogg">
</video>
<p>Here the video is stored in a NextCloud instance. How to:</p>
......
......@@ -31,6 +31,7 @@ hash: true,
history: true,
transitionSpeed: 'slow',
transition: 'fade',
loop: true,
dependencies: [
{ src: '../../epiphaneia/cyber/revealjs/plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: '../../epiphaneia/cyber/revealjs/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
......
......@@ -7,7 +7,7 @@
customize.talk
You may start by de-uncustomizing the topic of your talk. Is that even a thing?
Edit: -->
<title>ἐπῐφᾰ́νειᾰ</title>
<title></title>
<noscript>
</noscript>
......@@ -41,42 +41,11 @@
<div class="reveal">
<div class="slides">
<!-- HERELobby -->
<section>
<p>You may choose</p>
<h2>If</h2>
<p>you are not interested in customizing the look & feel of the presentation then do click <a href="#/#begin">here</a>.</p>
<h2>Else</h2>
<p>you may be interested in customizing the look & feel of the presentation or just want to go with the flow, i.e. watch and interact with the hypertextual programmed intro sequence as intended. Do click <a onclick="Reveal.next()">here</a>.</p>
</section>
<section data-background="../../epiphaneia/cyber/documentation/cube_subraum.svg" id="cube" data-autoslide="1000">
<p class="fragment fade-out" data-fragment-index="0" data-autoslide="3000">kindly brought to you by</p>
<h1 class="fragment fade-in-then-out" data-fragment-index="0" data-autoslide="3000">C3PB e.V.</h1>
<p class="fragment fade-down" data-fragment-index="1" data-autoslide="10000">
Alas! The desktop cube <br>
<a href="?transition=none#/cube">None</a> -
<a href="?transition=fade#/cube">Fade</a> -
<a href="?transition=slide#/cube">Slide</a> -
<a href="?transition=convex#/cube">Convex</a> -
<a href="?transition=concave#/cube">Concave</a> -
<a href="?transition=zoom#/cube">Zoom</a>
</p>
<p class="fragment fade-up" data-fragment-index="1"><a href="#/#brb">BRB</a> OR GOTO <a href="#/#customizedthemes">THEMES</a></p>
</section>
<section data-background="../../epiphaneia/cyber/documentation/cube_subraum.svg" id="brb">
<p class="fragment fade-out" data-autoslide="1000" data-autoslide-index="2">"FREE PRESS" for BIG PICTURE</p>
<!-- Reload without using the cache: true -->
<div class="fragment grow" data-autoslide="1000" data-autoslide-index="1">
<a onclick="window.location.reload(true);">
<div class="button fragment shrink" data-autoslide="1000">DONT<br>PRESS</div>
</a>
</div>
<h3 class="fragment fade-up" onclick="openFullscreen();" data-autoslide="6000">BIG RED BUTTON</h3>
<p>GOTO <a href="#/#lobby">Lobby</a> OR Almost <a href="#/#end">THE END</a></p>
</section>
<!--- Edit: Title slide -->
<section data-background="../../epiphaneia/cyber/documentation/cube_subraum.svg" id="lobby">
<h3><a class="fragment fade-down" data-fragment-index="1" id="twice" data-autoslide="1000" onclick='document.getElementById("twice").innerHTML = "FULL SCREEN VIEW:";'>επιφανεια </a><span class="fragment fade-right" data-autoslide="12000" data-fragment-index="2"> <p class="button" onclick='openFullscreen(); Reveal.toggleAutoSlide(true); Reveal.next()'>FREE<br>PRESS</p></span></h3>
<h3><a class="fragment fade-down" data-fragment-index="1" id="twice" data-autoslide="1000" onclick='document.getElementById("twice").innerHTML = "FULL SCREEN VIEW:";'>επιφανεια </a><span class="fragment fade-right" data-autoslide="12000" data-fragment-index="2"> <p class="button" onclick='openFullscreen(); Reveal.toggleAutoSlide(true); Reveal.next()'>BIG<br>PIC</p></span></h3>
<p class="fragment fade-up" data-fragment-index="0" data-autoslide="1000"><a onclick='Reveal.toggleAutoSlide(true); document.getElementById("twice").innerHTML = "Press 4 Big Picture:";'><img class="plain" id="explainsitself" src="../../epiphaneia/cyber/documentation/projectIcon.png"></a></span></p>
<p><a href="#/#begin">JUMP TO START</a></p>
</section>
<!-- Edit: Theme selection -->
<section data-background="../../epiphaneia/cyber/documentation/cube_subraum.svg" id="customizedthemes" data-autoslide="1000">
......@@ -99,7 +68,7 @@
<a href="#" onclick="document.getElementById('theme').setAttribute('href','../../epiphaneia/cyber/css/deelight.css'); return false;">Deelight</a> -
<a href="#" onclick="document.getElementById('theme').setAttribute('href','../../epiphaneia/cyber/css/hackoer.css'); return false;">Hackör</a>
</p>
<p class="fragment fade-up" data-fragment-index="1">GOTO <a href="#/#brb">BRB</a>, <a href="#/#lobby">LOBBY</a>, <a href="#/#cube">CUBE</a> OR <a href="#/#end">JUMP</a> the queue</p>
<p class="fragment fade-up" data-fragment-index="1">GOTO <a href="#/#lobby">LOBBY</a> OR <a href="#/#end">JUMP</a> the queue</p>
</section>
<!-- MARKDOWN IMPORT SECTION -->
<section id="begin"
......@@ -124,7 +93,7 @@
<section>
<section id="credits" data-background="https://cloud.c3pb.de/s/wPGaWp4SPGCA86i/preview">
<h1 class="fragment fade-down" data-autoslide="2500" data-fragment-index="1">
<a href="https://git.c3pb.de/ak/epiphaneia" data-preview-link="false">hold</a>
<a href="https://git.c3pb.de/ak/epiphaneia" data-preview-link="false"><img src="https://ak.pages.c3pb.de/epiphaneia/../../epiphaneia/cyber/documentation/fork.svg" width="33%"></a>
</h1>
<p class="fragment fade-in-then-out" data-autoslide="5000" data-fragment-index="2">&uarr; your own &darr;</p>
<h2>επιφανεια</h2>
......@@ -136,17 +105,12 @@
<section data-background="https://cloud.c3pb.de/s/wPGaWp4SPGCA86i/preview" data-autoslide="2500">
<p class="fragment fade-in-then-semi-out">a word by no sponsor</p>
<div class="fragment fade-up" data-autoslide="30000">
<a href="#lobby"><h1>Generic</h1>
<a href="#lobby"><h1>Live long</h1>
<p>επιφανεια</p>
<h1>Message</h1>
<h1>& prop her</h1>
</a>
</div>
</section>
<section data-background-iframe="https://writer.c3pb.de/s/BkBlhMPd8#Quickstart" data-background-interactive data-autoslide="2500">
<p class="fragment fade-out" data-fragment-index="3">Documentation Shared Makes Good Software Even Better</p>
<h1 class="fragment fade-in-then-out" data-fragment-index="0">Read IT</h1>
<h1 class="fragment fade-in-then-out" data-fragment-index="2">Write IT</h1>
</section>
</section>
</div>
</div>
......@@ -172,12 +136,10 @@
<li>to trust the domain <a href="">c3pb.de</a> to have at least tried & push IT over boundaries</li>
</ul>
<div >
<a href="index.txt">
<a href="index.md">
<div class="button">NUKE<br>IT NOW</div>
</a>
</div>
<p>straigt up <a href="https://en.wikipedia.org/wiki/Fu"></a> to un-<a href="https://en.wikipedia.org/wiki/Fu"></a> the way - kindly brought to you by</p>
<a href="https://c3pb.de/pages/impressum.html"><h1>C3PB e. V.</h1></a>
</section>
</div>
</div>
......
......@@ -83,7 +83,7 @@
<h1 class="title">Taskwarrior Integration</h1>
<p class="subtitle">How-to for Pykyll</p>
<p class="author">ak</p>
<p class="date">2021-Mar-10 12:38</p>
<p class="date">2021-Mar-12 21:50</p>
</header>
<nav id="TOC" role="doc-toc">
<ul>
......
......@@ -83,7 +83,7 @@
<h1 class="title">Documentation Management</h1>
<p class="subtitle">How-to with Pykyll</p>
<p class="author">ak</p>
<p class="date">2021-Mar-06 20:43</p>
<p class="date">2021-Mar-12 21:52</p>
</header>
<nav id="TOC" role="doc-toc">
<ul>
......@@ -110,7 +110,7 @@ How to manage your software documentation with Pykyll
<p>and edit it accordingly. If Gitlab Pages has been correctly set up and the runner executes successfully your project documentation will appear on-line once you have:</p>
<ul>
<li>Installed the pykyll submodule</li>
<li>Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from <code>htmlout</code>, which holds your documentation web site be the only folder touched by Pykyll</li>
<li>Added a topic in Pykylls [a] Add Menu: This will be your documentation folder and apart from <code>htmlout</code>, which holds your documentation web site and will in addition to the folders you are creating from within the software be the only folder ever touched by Pykyll.</li>
<li>Run a [c] Concise Check from Pykylls [c] Check Menu to build up a Table of Contents</li>
<li>Edit your software documentation with your favourite text editor. Tip: Can be set in Pykyll. In this way the last edited time stamp tag in the topics frontmatter will be updated</li>
<li>Change the <code>type</code> frontmatter tag from <code>topic</code> to <code>post</code> for a flat hierarchy. Leave it as <code>topic</code> and add some posts to provide a manual, where the topics are the chapters</li>
......
This diff is collapsed.
......@@ -109,7 +109,7 @@ Pykyll – <a href="examples">Docs </a> – <a href="my_lipsum">Lorem </a>
</figure>
<blockquote>
<p>The best software is the one in which you see everything on first glance</p>
<p>––– Freaky Spider</p>
<p>––– A certain freaky spider</p>
</blockquote>
<h1 id="command-line-view-more">Command Line View &amp; More</h1>
<figure>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment