https://github.com/groovytron/generator-skjol

Generator used to share documentation generation environment using docker containers
https://github.com/groovytron/generator-skjol

blockdiag c4 diagram docker docker-compose documentation erd kroki latex markdown mermaid nomnoml pandoc plantuml

Last synced: 10 days ago
JSON representation

Generator used to share documentation generation environment using docker containers

• Host: GitHub
• URL: https://github.com/groovytron/generator-skjol
• Owner: groovytron
• License: mit
• Created: 2019-04-30T07:22:55.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-02-07T14:14:11.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T11:04:24.235Z (14 days ago)
• Topics: blockdiag, c4, diagram, docker, docker-compose, documentation, erd, kroki, latex, markdown, mermaid, nomnoml, pandoc, plantuml
• Language: TypeScript
• Homepage:
• Size: 729 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-skjol

[![npm version](https://badge.fury.io/js/generator-skjol.svg)](https://badge.fury.io/js/generator-skjol)

![CI](https://github.com/groovytron/generator-skjol/workflows/CI/badge.svg?branch=master)

[![Coverage Status](https://coveralls.io/repos/github/groovytron/generator-skjol/badge.svg?branch=main)](https://coveralls.io/github/groovytron/generator-skjol?branch=main)

![](./images/dawg.jpg)

Need to document your project with schemas (UML, Graphs, ...), a PDF report or

slides?

Skjöl is for you! Skjöl allows you to scaffold the needed configuration into

your project to be able to generate documentation only based on

simple text files.

Skjöl is a group of generators and contains the following:

- `kroki`: scaffolds a `docker-compose` stack that uses [kroki](https://kroki.io/)

to generate diagrams and schemas from text files

- `slides`: scaffolds a slide show based on Markdown and ouputs

a [reveal.js](https://revealjs.com/) presentation with [pandoc](https://pandoc.org/)

- `report`: scaffolds a `docker-compose` stack that uses `pandoc` to generate

a PDF from a Markdown file

Now you can wonder why this generator is named skjöl. Simply because *skjöl*

means *documents* in icelandic. That might be disappointing but that's why!

## Installation

To install this generators on your system, run

`npm install --global generator-skjol`.

## Use the generators

You can then call the generators using Yeoman.

To scaffold slides documentation in a folder named `my-slides`,

run `yo skjol:slides my-slides`.

To scaffold diagrams documentation in a folder named `my-diagrams`,

run `yo skjol:kroki my-diagrams`.

To scaffold a report documentation in a folder named `my-report`,

run `yo skjol:report my-report`.