https://github.com/2425-4bhitm-sew/2425-4bhitm-sew-lecture-notes

https://github.com/2425-4bhitm-sew/2425-4bhitm-sew-lecture-notes

angular java quarkus

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/2425-4bhitm-sew/2425-4bhitm-sew-lecture-notes
• Owner: 2425-4bhitm-sew
• Created: 2024-09-19T05:10:58.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-12-04T08:24:24.000Z (about 2 months ago)
• Last Synced: 2024-12-04T09:30:01.472Z (about 2 months ago)
• Topics: angular, java, quarkus
• Language: Java
• Homepage: https://2425-4bhitm-sew.github.io/2425-4bhitm-sew-lecture-notes/
• Size: 6.32 MB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
= asciidoctor-html-template

Thomas Stütz

1.0.0, {docdate}

:imagesdir: img

:icons: font

:sectnums:    // Nummerierung der Überschriften / section numbering

// :toc:

// :toclevels: 1

:experimental:

//https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74?permalink_comment_id=3948218

ifdef::env-github[]

:tip-caption: :bulb:

:note-caption: :information_source:

:important-caption: :heavy_exclamation_mark:

:caution-caption: :fire:

:warning-caption: :warning:

endif::[]

image::https://img.shields.io/badge/version-1.0.0-blue[]

== doc-as-code

=== Overview

The purpose of this template is to convert adoc-Files to html-Files

These files are divided in html-documents and html-slides. The slides are rendered using https://revealjs.com/[revealjs^].

The convertion of the adoc-files is processed in a docker-container.

image::/img/adoc-to-html.png[]

=== Usage

==== Initial Configuration

* After templating this repo commit and push the demo page

* Set Settings - Pages - Branch: gh-pages - Folder: / (root)

+

[%collapsible]

====

image::/img/permissions-for-asciidoc-2.png[]

====

==== Accessing the Website(s) for docs

* https://**.github.io/**

** ie https://htl-leonding-college.github.io/asciidoctor-html-template

==== Accessing the Website(s) for slides

* https://**.github.io/**/demo/**

** ie https://htl-leonding-college.github.io/asciidoctor-html-template/slides/demo.html

==== Remote Rendering by github-actions

When commiting and pushing the adoc-files into github, they are automatically rendered by github-actions to html in a (new) branch `gh-pages`. All sub-folders with adoc-files are included.

==== Local Rendering

Because the rendering with gh-actions on a gh-runner takes time, it is possible to create a local dist-folder with

[source,bash]

----

./local-convert.sh

----

IMPORTANT: You need docker installed locally.

You even can publish your locally created html-slides with

[source,bash]

----

./publish.sh

----

=== Customizing

IMPORTANT: You should not change the scripts in the `asciidocs`-folder, unless you really know what to do.

* The script are available in the `asciidocs`-Folder. So you could change the options for the asciidoctor-engine or the version of revealjs.

=== Docs

** https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[Asciidoctor Quick Reference]

** https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc Writer’s Guide^]

** https://docs.asciidoctor.org/reveal.js-converter/latest/converter/features/[Slides with Asciidoctor for revealjs^]