{"id":16958440,"url":"https://github.com/dohliam/workflow","last_synced_at":"2025-04-14T09:20:21.877Z","repository":{"id":88992173,"uuid":"68647038","full_name":"dohliam/workflow","owner":"dohliam","description":"Quick prototyping script for creating rich html and pdfs from markdown documents","archived":false,"fork":false,"pushed_at":"2023-04-10T23:28:42.000Z","size":6,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T22:42:36.580Z","etag":null,"topics":["css","html","markdown","pdf","prototyping","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/dohliam.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2016-09-19T21:10:26.000Z","updated_at":"2024-04-20T22:44:57.000Z","dependencies_parsed_at":"2023-06-13T11:15:19.865Z","dependency_job_id":null,"html_url":"https://github.com/dohliam/workflow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dohliam%2Fworkflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dohliam%2Fworkflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dohliam%2Fworkflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dohliam%2Fworkflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dohliam","download_url":"https://codeload.github.com/dohliam/workflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852186,"owners_count":21171843,"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":["css","html","markdown","pdf","prototyping","ruby"],"created_at":"2024-10-13T22:42:36.479Z","updated_at":"2025-04-14T09:20:21.865Z","avatar_url":"https://github.com/dohliam.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Workflow - Quick prototyping script for creating rich html and pdfs from markdown documents\n\n[Workflow](https://github.com/dohliam/workflow) is a small script for generating nice-looking web pages and pdf documents from markdown using a [CSS switcher](https://github.com/dohliam/dropin-minimal-css). This means that creating a webpage or pdf is simply a matter of writing some content in markdown and choosing a CSS template, which can drastically reduce the amount of time required to put documentation online.\n\n## Requirements\n\n* [ruby](https://www.ruby-lang.org/en/) and the [kramdown](https://github.com/gettalong/kramdown) gem\n* [wkhtmltopdf](https://github.com/wkhtmltopdf/wkhtmltopdf)\n* [rinku](https://github.com/vmg/rinku) for autolinking\n\n## Usage\n\nGiven a plain markdown document, Workflow by default will create an html file with an embedded switcher, allowing you to cycle interactively through a list of CSS templates to see which one works best with your document. You can try this by [cloning or downloading the project](https://github.com/dohliam/workflow) and running the following command on this readme file from within the project directory:\n\n```bash\n/.workflow.rb README.md\n```\n\nOnce you have decided on a CSS template, just run workflow.rb again with the `-s` option to generate a permanent file with your chosen CSS included:\n\n```bash\n./workflow.rb -s siimple README.md\n```\n\nUse the `-p` option to create a PDF using your selected CSS template:\n\n```bash\n./workflow.rb -ps siimple README.md\n```\n\nYou can view an [online demo](https://dohliam.github.io/workflow) or [download a pdf](https://dohliam.github.io/workflow/workflow.pdf) which is the result of running the above commands.\n\n## Code highlighting\n\nSyntax highlighting for code blocks uses [pygments-css](https://github.com/richleland/pygments-css) via the [Pygments CSS Stylesheets Previewer](https://dohliam.github.io/pygments-css/).\n\nUse the `-c` option to turn on syntax highlighting.\n\n```bash\n./workflow.rb -cps siimple README.md\n```\n\nTo use a different highlighting theme than the default, specify a Pygments CSS style using the `-C` option. For example, to use the Solarized Light theme:\n\n```bash\n./workflow.rb -cps siimple -C solarized-light README.md\n```\n\nTo see all the available syntax highlighting themes, take a look at the [online style switcher](https://dohliam.github.io/pygments-css/) for Pygments CSS, with sample code in a variety of programming languages.\n\n## Options\n\n* `-c`, `--code-highlighting`: _Use code syntax highlighting_\n* `-C`, `--code-style [STYLE]`: _Specify style to use for syntax highlighting_\n* `-f`, `--fixes`: _Fixes some common display problems with pdfs_\n* `-h`, `--header TEXT`: _Add arbitrary header text to top of each pdf page_\n* `-o`, `--output NAME`: _Basename of output file (by default same as input file)_\n* `-p`, `--pdf`: _Create pdf instead of html_\n* `-n`, `--numbers`: _Add a footer with page numbers_\n* `-s`, `--stylesheet NAME`: _Specify name of stylesheet to use instead of CSS switcher_\n\n## Related projects\n\n* [dropin-minimal-css](https://github.com/dohliam/dropin-minimal-css), on which this script is based\n* [asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins), for a similar idea but with asciidoctor\n\n## License\n\nMIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdohliam%2Fworkflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdohliam%2Fworkflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdohliam%2Fworkflow/lists"}