{"id":19356353,"url":"https://github.com/groovytron/generator-skjol","last_synced_at":"2025-04-23T10:32:44.529Z","repository":{"id":42242088,"uuid":"184212573","full_name":"groovytron/generator-skjol","owner":"groovytron","description":"Generator used to share documentation generation environment using docker containers","archived":false,"fork":false,"pushed_at":"2025-02-18T22:53:05.000Z","size":1269,"stargazers_count":2,"open_issues_count":13,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T14:11:14.073Z","etag":null,"topics":["blockdiag","c4","diagram","docker","docker-compose","documentation","erd","kroki","latex","markdown","mermaid","nomnoml","pandoc","plantuml"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/groovytron.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-30T07:22:55.000Z","updated_at":"2024-06-21T06:30:46.000Z","dependencies_parsed_at":"2023-02-19T11:25:21.148Z","dependency_job_id":null,"html_url":"https://github.com/groovytron/generator-skjol","commit_stats":{"total_commits":115,"total_committers":4,"mean_commits":28.75,"dds":"0.26956521739130435","last_synced_commit":"7555a87c19b89b0b8111acf6790e654cd1a024a7"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groovytron%2Fgenerator-skjol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groovytron%2Fgenerator-skjol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groovytron%2Fgenerator-skjol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groovytron%2Fgenerator-skjol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/groovytron","download_url":"https://codeload.github.com/groovytron/generator-skjol/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250178136,"owners_count":21387733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockdiag","c4","diagram","docker","docker-compose","documentation","erd","kroki","latex","markdown","mermaid","nomnoml","pandoc","plantuml"],"created_at":"2024-11-10T07:04:07.414Z","updated_at":"2025-04-23T10:32:39.513Z","avatar_url":"https://github.com/groovytron.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-skjol\n\n[![npm version](https://badge.fury.io/js/generator-skjol.svg)](https://badge.fury.io/js/generator-skjol)\n![CI](https://github.com/groovytron/generator-skjol/workflows/CI/badge.svg?branch=master)\n[![Coverage Status](https://coveralls.io/repos/github/groovytron/generator-skjol/badge.svg?branch=main)](https://coveralls.io/github/groovytron/generator-skjol?branch=main)\n\n![](./images/dawg.jpg)\n\nNeed to document your project with schemas (UML, Graphs, ...), a PDF report or\nslides?\nSkjöl is for you! Skjöl allows you to scaffold the needed configuration into\nyour project to be able to generate documentation only based on\nsimple text files.\n\nSkjöl is a group of generators and contains the following:\n\n- `kroki`: scaffolds a `docker-compose` stack that uses [kroki](https://kroki.io/)\nto generate diagrams and schemas from text files\n- `slides`: scaffolds a slide show based on Markdown and ouputs\na [reveal.js](https://revealjs.com/) presentation with [pandoc](https://pandoc.org/)\n- `report`: scaffolds a `docker-compose` stack that uses `pandoc` to generate\na PDF from a Markdown file\n\nNow you can wonder why this generator is named skjöl. Simply because *skjöl*\nmeans *documents* in icelandic. That might be disappointing but that's why!\n\n## Installation\n\nTo install this generators on your system, run\n`npm install --global generator-skjol`.\n\n## Use the generators\n\nYou can then call the generators using Yeoman.\n\nTo scaffold slides documentation in a folder named `my-slides`,\nrun `yo skjol:slides my-slides`.\n\nTo scaffold diagrams documentation in a folder named `my-diagrams`,\nrun `yo skjol:kroki my-diagrams`.\n\nTo scaffold a report documentation in a folder named `my-report`,\nrun `yo skjol:report my-report`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgroovytron%2Fgenerator-skjol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgroovytron%2Fgenerator-skjol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgroovytron%2Fgenerator-skjol/lists"}