{"id":16371043,"url":"https://github.com/liquidz/clj-vimhelp","last_synced_at":"2025-10-26T07:32:56.103Z","repository":{"id":40492649,"uuid":"173913373","full_name":"liquidz/clj-vimhelp","owner":"liquidz","description":"Vim help file parser/convertor written by Clojure","archived":false,"fork":false,"pushed_at":"2022-12-26T11:25:25.000Z","size":54,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-31T16:55:28.585Z","etag":null,"topics":["clojure","convertor","parser","vim","vim-help"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liquidz.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"liquidz","patreon":"uochan","ko_fi":"uochan","custom":"https://paypal.me/uochan"}},"created_at":"2019-03-05T09:12:21.000Z","updated_at":"2022-05-05T00:22:07.000Z","dependencies_parsed_at":"2023-01-31T00:02:08.352Z","dependency_job_id":null,"html_url":"https://github.com/liquidz/clj-vimhelp","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidz%2Fclj-vimhelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidz%2Fclj-vimhelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidz%2Fclj-vimhelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidz%2Fclj-vimhelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liquidz","download_url":"https://codeload.github.com/liquidz/clj-vimhelp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238293115,"owners_count":19448122,"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":["clojure","convertor","parser","vim","vim-help"],"created_at":"2024-10-11T03:06:50.042Z","updated_at":"2025-10-26T07:32:55.669Z","avatar_url":"https://github.com/liquidz.png","language":"Clojure","funding_links":["https://github.com/sponsors/liquidz","https://patreon.com/uochan","https://ko-fi.com/uochan","https://paypal.me/uochan"],"categories":[],"sub_categories":[],"readme":"= clj-vimhelp\n:toc:\n:toc-placement: preamble\n:toclevels: 2\n\n// Need some preamble to get TOC:\n{empty}\n\nVim help file parser/convertor written by Clojure.\n\nimage:https://github.com/liquidz/clj-vimhelp/workflows/test/badge.svg[\"GitHub Actions for test workflow\", link=\"https://github.com/liquidz/clj-vimhelp/actions?query=workflow%3Atest\"]\nimage:https://github.com/liquidz/clj-vimhelp/workflows/lint/badge.svg[\"GitHub Actions for lint workflow\", link=\"https://github.com/liquidz/clj-vimhelp/actions?query=workflow%3Alint\"]\n\n== Getting Started\nDownload binary from releases.\n\n[source,sh]\n----\n# Download latest vimhelp to the current working directory\ncurl -L https://raw.githubusercontent.com/liquidz/clj-vimhelp/main/script/download | bash\n./vimhelp --help\n----\n\n== Convertor\n\nConvert vim help file to HTML.\n\n=== Usage\n\n----\nclojure -Sdeps '{:deps {liquidz/clj-vimhelp {:git/url \"https://github.com/liquidz/clj-vimhelp\" :sha \"38dea58d0516f8f6bbc424da14300c831a824242\"}}}' \\\n    -m vimhelp.core \u003cfile1\u003e \u003cfile2\u003e ... \u003cfileN\u003e [OPTIONS]\n----\n.Options\n|===\n|Short | Long | Note | Default value\n\n| -c | --css URL             | CSS URL                | `[]`\n| -t | --title TITLE         | Help title             | no title\n| -s | --style STYLE         | CSS style rules        |\n| -o | --output OUTPUT       | Output directory       |\n| -w | --wrapper WRAPPER     | Body wrapper div class | container\n|    | --copyright COPYRIGHT | Copyright text         |\n|    | --blob BLOB           | Blob URL               |\n|    | --index INDEX         | Index file name        |\n| -v | --verbose             |                        |\n| -h | --help                |                        |\n|===\n\n\n\n\n== Parser\n\nParse vim help to to Clojure data structure.\n\n=== Usage\n\n[source,clojure]\n----\n(require '[vimhelp.parser :as p]\n         '[clojure.java.io :as io])\n\n(with-open [r (io/reader \"/path/to/vim/help/file\")]\n  (p/parse r))\n----\n\n=== Parsed data structure\n\n[cols=\"a,a,l\"]\n|===\n| Line category | Text category | Example\n\n| `:text`    | `:tag`            | *tag*\n|            | `:ref`            | \\|tag\\|\n|            | `:command`        | `command`\n|            | `:constant`       | {const}\n|            | `:divider`        |\n====\n----\n|            | `:section-header` | HEADER   *section-tag*\n|            | `:header`         | HEADER~\n|            | `:url`            | https://example.com\n| `:example` |                   |\n\u003e\n hello\n\u003c\n|===\n\n== Native image\n* GraalVM is required.\n* `$GRAALVM_HOME` must be defined.\n* Run `make native-image` to make native image.\n\n== License\n\nCopyright © 2019-2020 https://twitter.com/uochan[Masashi Iizuka]\n\nThis program and the accompanying materials are made available under the\nterms of the Eclipse Public License 2.0 which is available at\nhttp://www.eclipse.org/legal/epl-2.0.\n\nThis Source Code may also be made available under the following Secondary\nLicenses when the conditions for such availability set forth in the Eclipse\nPublic License, v. 2.0 are satisfied: GNU General Public License as published by\nthe Free Software Foundation, either version 2 of the License, or (at your\noption) any later version, with the GNU Classpath Exception which is available\nat https://www.gnu.org/software/classpath/license.html.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliquidz%2Fclj-vimhelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliquidz%2Fclj-vimhelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliquidz%2Fclj-vimhelp/lists"}