{"id":32472051,"url":"https://github.com/OXY2DEV/tree-sitter-doctext","last_synced_at":"2025-10-26T17:03:03.787Z","repository":{"id":308885438,"uuid":"1015136929","full_name":"OXY2DEV/tree-sitter-doctext","owner":"OXY2DEV","description":"Tree-sitter parser for conventional comments","archived":false,"fork":false,"pushed_at":"2025-10-02T12:35:29.000Z","size":1102,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-23T00:40:34.638Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/OXY2DEV.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-07T04:11:04.000Z","updated_at":"2025-10-20T19:56:46.000Z","dependencies_parsed_at":"2025-08-08T14:20:12.931Z","dependency_job_id":"e5674e50-91e7-4de6-afab-e7bfb988a029","html_url":"https://github.com/OXY2DEV/tree-sitter-doctext","commit_stats":null,"previous_names":["oxy2dev/tree-sitter-doctext"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OXY2DEV/tree-sitter-doctext","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Ftree-sitter-doctext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Ftree-sitter-doctext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Ftree-sitter-doctext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Ftree-sitter-doctext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXY2DEV","download_url":"https://codeload.github.com/OXY2DEV/tree-sitter-doctext/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXY2DEV%2Ftree-sitter-doctext/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281139039,"owners_count":26450141,"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","status":"online","status_checked_at":"2025-10-26T02:00:06.575Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-26T17:02:14.898Z","updated_at":"2025-10-26T17:03:03.781Z","avatar_url":"https://github.com/OXY2DEV.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# tree-sitter-doctext\n\n![Syntax highlighting](./images/doctext-demo.png)\n\n[Tree-sitter](https://github.com/tree-sitter/tree-sitter) parser for [conventional comments](https://conventionalcomments.org/).\n\n\u003e[!NOTE]\n\u003e It wasn't named `tree-sitter-comment` as that name is already taken and this parser isn't strictly for `comments`.\n\n## 💡 Features\n\n- Supports a subset of `markdown` such as,\n    + *Italic text*\n    + **Bold text**\n    + `Inline_code`\n    + `Code blocks`\n- Supports extra syntax such as,\n    + `'Single quoted text'`\n    + `\"Double quoted text\"`\n    + `@mentions`\n    + `owner/repo#12`(Issue reference)\n    + `https://example.com`(links)\n- Supports correct tree structure for topics, subjects, description etc. to be leveraged by plugins/external programs.\n- Queries(syntax \u0026 injection) for common comment topics(e.g. NOTE, WIP, FIX etc.).\n\n## 📥 Installation\n\n### 💡 nvim-treesitter\n\n\u003e[!IMPORTANT]\n\u003e If you plan on using it inside comments, you also need to add it as an injection for that language.\n\nPut this in your `nvim-treesitter` config,\n\n```lua\nlocal parser_configs = require(\"nvim-treesitter.parsers\").get_parser_configs();\n\nparser_configs.doctext = {\n    install_info = {\n        url = \"https://github.com/OXY2DEV/tree-sitter-doctext\",\n        files = { \"src/parser.c\" },\n        branch = \"main\",\n    },\n}\n```\n\nNow, quit \u0026 open Neovim and run this command,\n\n```vim\n:TSInstall doctext\n```\n\n### 💡 manual\n\n1. Install the `tree-sitter` CLI tool.\n\n2. Clone the repository in your machine and `cd` into it.\n\n3. Run `tree-sitter build`(if it tells you to install dependencies then you should install them and retry).\n\n4. Copy the `doctext.so` file to `~/.config/nvim/parser/`.\n\n## 💥 Query files(syntax highlighting \u0026 injections)\n\nCopy everything inside `queries/` to `~/.config/nvim/queries/doctext/` in your machine.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOXY2DEV%2Ftree-sitter-doctext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOXY2DEV%2Ftree-sitter-doctext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOXY2DEV%2Ftree-sitter-doctext/lists"}