{"id":15010370,"url":"https://github.com/kimim/chatu","last_synced_at":"2025-04-09T18:33:58.165Z","repository":{"id":221628642,"uuid":"754929672","full_name":"kimim/chatu","owner":"kimim","description":"Quickly insert a generated image to orgmode or markdown, fast and conveniently.","archived":false,"fork":false,"pushed_at":"2025-04-03T00:46:10.000Z","size":754,"stargazers_count":22,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-03T01:27:04.917Z","etag":null,"topics":["babashka","clojure","drawio","emacs","lilypond","markdown-mode","org-mode","plantuml","python","r"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kimim.png","metadata":{"files":{"readme":"docs/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":"2024-02-09T03:31:00.000Z","updated_at":"2025-04-03T00:46:13.000Z","dependencies_parsed_at":"2024-05-18T07:25:49.991Z","dependency_job_id":"8bf40aff-42dc-4288-b744-62f627302fba","html_url":"https://github.com/kimim/chatu","commit_stats":null,"previous_names":["kimim/chatu"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kimim%2Fchatu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kimim%2Fchatu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kimim%2Fchatu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kimim%2Fchatu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kimim","download_url":"https://codeload.github.com/kimim/chatu/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248088192,"owners_count":21045664,"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":["babashka","clojure","drawio","emacs","lilypond","markdown-mode","org-mode","plantuml","python","r"],"created_at":"2024-09-24T19:33:44.435Z","updated_at":"2025-04-09T18:33:58.156Z","avatar_url":"https://github.com/kimim.png","language":"Emacs Lisp","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\nA small tool converts various files to .svg files or downloads image\nfiles, and inserts them to orgmode or markdown buffer on-the-fly.\n\n**插 chā 图 tú**: insert a diagram.\n\nSee examples in [chatu.org](./chatu.org) and [chatu.md](./chatu.md).\n\n# Install\n\nBefore using `chatu`, you may need to install some external programs and\nset them in your PATH:\n- draw.io and pdf2svg for drawio file conversion\n- plantuml.jar, java for plantuml\n- clojure for .clj script\n- babashka for .bb script\n- Python for .py script\n- curl for downloading file from web\n- R for statistic plotting\n- lilypond for music notes\n\nAdd `chatu.el` from melpa with use-package:\n\n```emacs-lisp\n(use-package chatu\n  :hook ((org-mode markdown-mode) . chatu-mode)\n  :commands (chatu-add\n             chatu-open)\n  :custom ((chatu-input-dir \"./draws\")\n           (chatu-output-dir \"./draws_out\")))\n```\n\nOr git submodule and use-package\n\n```emacs-lisp\n(use-package chatu\n  :load-path \"~/.emacs.d/site-lisp/chatu\"\n  :hook ((org-mode markdown-mode) . chatu-mode)\n  :commands (chatu-add\n             chatu-open)\n  :custom ((chatu-input-dir \"./draws\")\n           (chatu-output-dir \"./draws_out\")))\n```\n\n## draw.io\n\nYou may need to add draw.io to your PATH. If you installed draw.io\nwith homebrew, `draw.io` executable is located in following path:\n\n```shell\nexport PATH=/opt/homebrew/Caskroom/drawio/24.2.5/draw.io.app/Contents/MacOS:$PATH\n```\n\n## plantuml\n\n![chatu for plantuml](./images/chatu.gif)\n\n### requirements\n\nWhen you want to use chatu with PlantUML on Emacs, you have to install the following:\n\n- PlantUML\n\n  Download one of the compiled JARs from the [official site](https://plantuml.com/ja/download) or install\n  the PlantUML package provided by your distributor.\n\n  If you are using Ubuntu, type the following command in a terminal:\n\n  `sudo sh -c 'apt-get update \u0026\u0026 apt-get install plantuml'`\n\n- [plantuml-mode](https://github.com/skuro/plantuml-mode)\n\n### setting\n\nYou have to define `plantuml-jar-path` in the init file, such as `$HOME/.emacs`.\n\n    (setq plantuml-jar-path \"/opt/local/share/java/plantuml/plantuml.jar\") ;change to the path in where you installed the jar.\n\nOn Ubuntu, you can get the JAR path that has been installed via apt by typing `dpkg -L plantuml | grep plantuml.jar`.\n\n# Usage\nAdd `chatu` line with `chatu-new` command:\n\n```org\n#+chatu: :drawio \"diagram.drawio\" :page 0 :input-dir \"./draws\" :output-dir \"./draws_out\" :output \"diagram.svg\" :crop :nopdf\n```\n```markdown\n\u003c!-- #+chatu: :drawio \"diagram.drawio\" :page 0 :input-dir \"./draws\" :output-dir \"./draws_out\" :output \"diagram.svg\" :crop :nopdf --\u003e\n```\n\nOptions/Settings:\n- `:drawio` specifies the backend, they can be `:planuml`, `:babashka`, `:curl` or others added in the future by you.\n- file name after backend keyword is the input file name.\n- `:page` species which page you want to import to buffer.\n- `:input-dir` and `:output-dir` are the folders for input or output file.\n- `:output` is the output file name.\n- `:crop` if you want to crop the empty white in page.\n- `:nopdf` if you do not want intermediate pdf file for drawio backend.\n\nMove cursor to `chatu` line,\n- `C-c C-c` will invoke `chatu-add` to add image in orgmode.\n- `C-c C-c C-c` will invoke `chatu-add` to add image in markdown-mode.  \n- `C-c C-o` will invoke `chatu-open` to open original .drawio or .puml file.\n\n`chatu` line means different in orgmode and markdown:\n- `#+chatu: :drawio` or `#+chatu: :plantuml` in orgmode\n- `\u003c-- #+chatu: :drawio --\u003e` or `\u003c-- #+chatu: :plantuml --\u003e` in markdown\n\n**Remind!**\n- the input files should be the first parameter, for example, .drawio\n  or .puml file.\n- in order to support whitespace in file and dir name, please \"quote\n  all of them\".\n\n# Extension\n\nYou can easily extend this package by adding new `chatu-\u003ctool\u003e.el`. For\nexample, when `\u003ctool\u003e = drawio`, you need to define `chatu-drawio-open` and  `chatu-drawio-script` in `chatu-drawio.el`.\n- `chatu-drawio-open` is invoked to open the drawio input file at the line.\n- `chatu-drawio-script` is used to generate the shell script for conversion.\n\nBoth method use a `keyword-plist` parameter, which contains the\n`chatu` settings from `chatu` line.\n\n```org\n#+chatu: :drawio \"diagram.drawio\" :page 0 :input-dir \"./draws\" :output-dir \"./draws_out\" :output \"diagram.svg\" :crop :nopdf :output-ext svg\n```\n\nFor example, we can get following `keyword-plist` from above `chatu` line:\n\n```emacs-lisp\n(:chatu t :type \"drawio\"\n :input \"diagram.drawio\" :output \"diagram.svg\" :page \"0\"\n :input-dir \"./draws\" :output-dir \"./draws_out\"\n :input-path \"./draws/diagram.drawio\"\n :output-path \"./draws_out/diagram.svg\"\n :output-ext \"svg\"\n :crop t\n :nopdf t)\n```\n\n# Usage\n\nSee example [chatu.org](./chatu.org) in orgmode and  [chatu.md](./chatu.md) in markdown-mode.\n\n## Simple Usage\n\norg-mode:\n```org\n#+chatu: :drawio \"diagram.drawio\"\n#+chatu: :plantuml \"diagram.puml\"\n#+chatu: :curl \"http://example.org/image.svg\"\n#+chatu: :babashka \"babashka.bb\"\n```\n\nmarkdown-mode:\n```markdown\n\u003c!-- #+chatu: :drawio \"diagram.drawio\" --\u003e\n\u003c!-- #+chatu: :plantuml \"diagram.puml\" --\u003e\n\u003c!-- #+chatu: :curl \"http://example.org/image.svg\" --\u003e\n\u003c!-- #+chatu: :babashka \"babashka.bb\" --\u003e\n```\n\n## Omit the extension\n\norg-mode:\n```org\n#+chatu: :drawio \"diagram\"\n#+chatu: :plantuml \"diagram\"\n```\n\nmarkdown-mode:\n```markdown\n\u003c!-- #+chatu: :drawio \"diagram\" --\u003e\n\u003c!-- #+chatu: :plantuml \"diagram\" --\u003e\n```\n\n## Add more properties\n\norg-mode:\n```org\n#+chatu: :drawio \"diagram\"\n#+name: workflow\n#+caption: chatu workflow\n```\n\n## Extract specific page\n\norg-mode:\n```org\n#+chatu: :drawio \"diagram.drawio\" :page 1\n#+chatu: :plantuml \"diagram.puml\" :page 1\n```\n\nmarkdown-mode:\n```markdown\n\u003c!-- #+chatu: :drawio \"diagram.drawio\" :page 1 --\u003e\n\u003c!-- #+chatu: :plantuml \"diagram.puml\" :page 1 --\u003e\n```\n\n## Even more specific\n\nAdd input-dir, output-dir and output file name\n\norg-mode:\n```org\n#+chatu: :drawio \"diagram.drawio\" :page 0 :input-dir \"./draws\" :output-dir \"./draws_out\" :output \"diagram.svg\"\n```\n\nmarkdown-mode:\n```markdown\n\u003c!-- #+chatu: :drawio \"diagram.drawio\" :page 0 :input-dir \"./draws\" :output-dir \"./draws_out\" :output \"diagram.svg\" --\u003e\n```\n\n# Contributors\n\n\u003ca href = \"https://github.com/kimim/chatu/graphs/contributors\"\u003e\n  \u003cimg src = \"https://contrib.rocks/image?repo=kimim/chatu\"/\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkimim%2Fchatu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkimim%2Fchatu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkimim%2Fchatu/lists"}