An open API service indexing awesome lists of open source software.

https://github.com/capsulecorplab/docs-as-code

A docs-as-code presentation made following a docs-as-code approach
https://github.com/capsulecorplab/docs-as-code

asciidoctor asciidoctor-reveal-js docs-as-code presentation reveal-js

Last synced: 4 months ago
JSON representation

A docs-as-code presentation made following a docs-as-code approach

Awesome Lists containing this project

README

          

= Docs-as-Code =

A https://capsulecorplab.github.io/docs-as-code/[presentation] made following a https://www.writethedocs.org/guide/docs-as-code/[docs-as-code] approach.

The deck is generated using https://docs.asciidoctor.org/reveal.js-converter/latest/[Asciidoctor reveal.js] - an AsciiDoc to HTML5 converter based on https://revealjs.com/[reveal.js].

The entire presentation is deployed to GitHub Pages by means of an automated build pipeline (for more information, see https://github.com/peaceiris/actions-gh-pages[GitHub Actions for GitHub Pages]).

== Usage ==

To view the presentation locally, clone the repo and run the build script:

git clone https://github.com/capsulecorplab/docs-as-code.git
cd docs-as-code
./build.sh