{"id":16942638,"url":"https://github.com/tmthrgd/jekyll-graphs","last_synced_at":"2025-10-07T23:30:32.792Z","repository":{"id":29893427,"uuid":"33439017","full_name":"tmthrgd/jekyll-graphs","owner":"tmthrgd","description":"A Jekyll plugin that produces svg graphs with graphviz, tex, mscgen, plantuml and shaape. [Not maintained].","archived":false,"fork":false,"pushed_at":"2016-03-06T05:29:47.000Z","size":26,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-27T11:33:12.816Z","etag":null,"topics":["ascii-art","graph","graphviz","jekyll","jekyll-plugin","kramdown","liquid","mscgen","plantuml","plugin","ruby","shaape","svg","tex"],"latest_commit_sha":null,"homepage":"","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/tmthrgd.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}},"created_at":"2015-04-05T11:35:31.000Z","updated_at":"2023-02-28T21:22:46.000Z","dependencies_parsed_at":"2022-08-23T05:00:22.696Z","dependency_job_id":null,"html_url":"https://github.com/tmthrgd/jekyll-graphs","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/tmthrgd%2Fjekyll-graphs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthrgd%2Fjekyll-graphs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthrgd%2Fjekyll-graphs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthrgd%2Fjekyll-graphs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmthrgd","download_url":"https://codeload.github.com/tmthrgd/jekyll-graphs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235661843,"owners_count":19025607,"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":["ascii-art","graph","graphviz","jekyll","jekyll-plugin","kramdown","liquid","mscgen","plantuml","plugin","ruby","shaape","svg","tex"],"created_at":"2024-10-13T21:12:31.792Z","updated_at":"2025-10-07T23:30:27.530Z","avatar_url":"https://github.com/tmthrgd.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jekyll-graphs\n\n## Installation\n\nInstall the required renderers with your favourite package manager, e.g. on Ubuntu: `$ [sudo] apt-get install graphviz mscgen`, and place the `jekyll-graphs.rb` plugin in your sites `_plugins` directory.\n\n## Usage\n\njekyll-graphs can be used in several ways, the most explicit way is to use liquid `{% renderer %}` blocks such as:\n\n### Liquid tags\n\nLiquid `{% *renderer* %}` blocks, where renderer is the name of the renderer, can be used wherever liquid is rendered.\n\n    {% *renderer* %}\n    /----+  DAAP /-----+-----+ Audio  /--------+\n    | PC |\u003c------| RPi | MPD |-------\u003e| Stereo |\n    +----+       +-----+-----+        +--------+\n       |                 ^ ^\n       |     ncmpcpp     | | mpdroid /---------+\n       +--------=--------+ +----=----| Nexus S |\n                                     +---------+\n    {% end*renderer* %}\n\n### Pages with _file tags\n\njekyll-graphs will also process pages specified in `{% *renderer*_file *file* %}` tags.\n\n    ---\n    permalink: /some/path/image.png\n    ---\n    \n    /----+  DAAP /-----+-----+ Audio  /--------+\n    | PC |\u003c------| RPi | MPD |-------\u003e| Stereo |\n    +----+       +-----+-----+        +--------+\n       |                 ^ ^\n       |     ncmpcpp     | | mpdroid /---------+\n       +--------=--------+ +----=----| Nexus S |\n                                     +---------+\n\n### Code blocks\n\nThe final way in which jekyll-graphs can be used is with code blocks when using the kramdown parser. For example:\n\n        /----+  DAAP /-----+-----+ Audio  /--------+\n        | PC |\u003c------| RPi | MPD |-------\u003e| Stereo |\n        +----+       +-----+-----+        +--------+\n           |                 ^ ^\n           |     ncmpcpp     | | mpdroid /---------+\n           +--------=--------+ +----=----| Nexus S |\n                                         +---------+\n    {: *renderer*=\"*renderer*\" }\n\nThis is the suggested method as it degrades the most gracefully outputting the source in `\u003cpre\u003e\u003ccode\u003e...\u003c/code\u003e\u003c/pre\u003e` tags.\n\n### Options\n\njekyll-graphs allows all the following options to be specified:\n\n    encoding\n        The encoding to use when proccessing the graphs. Defaults to the site encoding or utf-8.\n    \n    renderer\n        The desired renderer. From the following lists:\n            graphviz: dot neato twopi circo fdp sfdp patchwork\n            tex: tex latex pdftex pdflatex xetex xelatex luatex lualatex\n            others: mscgen plantuml shaape\n    \n    format\n        The output format of the svg. Supported values:\n            img: \u003cimg src=\"...svg\" alt=\"...\" title=\"...\"\u003e\n            object: \u003cobject data=\"...svg\" type=\"image/svg+xml\"\u003e\u003ca href=\"...svg\"\u003e...\u003c/a\u003e\u003c/object\u003e\n            embed: \u003cembed src=\"...svg\" type=\"image/svg+xml\" /\u003e\n            iframe: \u003ciframe src=\"...svg\" sandbox=\"allow-scripts\"\u003e\u003c/iframe\u003e\n            url, uri, href: ...svg\n            svg: \u003csvg ...\u003e...\u003c/svg\u003e\n        \n        Defaults to svg.\n\nThe liquid block and kramdown code block methods also permit the following extra options to be specified:\n\n    dirname\n        The output path of the rendered image. This may contain %{hash} which\n        will be replaced by a hexadecimal string unquie to the image, and %{slug}\n        which will be replaced with a slug either generated from the graph or\n        the name of the renderer.\n    \n    name\n        The output filename of the rendered image. This may contain %{hash}\n        which will be replaced by a hexadecimal string unquie to the image, and %{slug}\n        which will be replaced with a slug either generated from the graph or\n        the name of the renderer.\n\nThe following global-only option may be specified:\n\n    renderers\n        It is a hash of key-values, with renderer names specified as keys and paths or\n        arguments specified as values. If a string is provided, it is expected to be the\n        path to the executable. If an array is provided, the first item will be treated as\n        the path to an executable and the remaining items as command line arguments.\n        \n        The command line arguments for PlantUML must be specified to use it. They should be\n        provided as [java, -jar, /path/to/plantuml.8021.jar].\n\n#### Global Configuration\n\nGlobal options may be set in your sites `_config.yml` file under the `jgraphs:` key. For example:\n\n    jgraphs:\n      dirname: /assets/images/\n      format: object\n      renderers:\n        plantuml: [java, -jar, ~/plantuml.8021.jar]\n\n#### Defaults\n\nThe following defaults are enforced:\n\n    :encoding =\u003e \"utf-8\",\n    :renderer =\u003e \"dot\",\n    :scale =\u003e 1.0\n\n## Acknowledgements\n\n[Graphviz](http://graphviz.org/) was developed by [AT\u0026T Labs Research](http://www.att.com/labs/) and other contributors.\n\n[TeX](https://www.tug.org/) was created by [Donald Knuth](https://cs.stanford.edu/~uno/) and others.\n\n[LaTeX](http://latex-project.org/) was created by [Leslie Lamport](http://www.lamport.org/) and others.\n\n[pdfTeX](https://www.tug.org/applications/pdftex/) was created by [Hàn Thế Thành](hanthethanh@gmail.com) and others.\n\n[XeTeX](http://xetex.sourceforge.net/) was created by Jonathan Kew and is developed by Khaled Hosny and others.\n\n[LuaTeX](http://www.luatex.org/) was created by Taco Hoekwater, Hartmut Henkel and Hans Hagen.\n\n[Mscgen](http://www.mcternan.me.uk/mscgen/) was created by [Michael McTernan](http://www.mcternan.me.uk/).\n\n[PlantUML](http://plantuml.com/) was created by Arnaud Roques.\n\n[Shaape](https://github.com/christiangoltz/shaape) was created by [Christian Goltz](https://github.com/christiangoltz).\n\n## License\n\nSee [LICENSE](https://github.com/tmthrgd/ditaa-ditaa/blob/master/LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmthrgd%2Fjekyll-graphs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmthrgd%2Fjekyll-graphs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmthrgd%2Fjekyll-graphs/lists"}