{"id":19388829,"url":"https://github.com/james2doyle/sublime-general-doc","last_synced_at":"2025-10-29T09:14:51.285Z","repository":{"id":145775660,"uuid":"243917301","full_name":"james2doyle/sublime-general-doc","owner":"james2doyle","description":"A plugin for Sublime Text that creates documentation from it's own config","archived":false,"fork":false,"pushed_at":"2020-06-21T18:09:26.000Z","size":533,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-07T08:48:51.642Z","etag":null,"topics":["documentation","plugin","sublime-text"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/james2doyle.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":"2020-02-29T06:29:53.000Z","updated_at":"2020-06-21T18:09:28.000Z","dependencies_parsed_at":"2023-03-25T23:48:59.152Z","dependency_job_id":null,"html_url":"https://github.com/james2doyle/sublime-general-doc","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/james2doyle%2Fsublime-general-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fsublime-general-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fsublime-general-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fsublime-general-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/james2doyle","download_url":"https://codeload.github.com/james2doyle/sublime-general-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240549434,"owners_count":19819131,"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":["documentation","plugin","sublime-text"],"created_at":"2024-11-10T10:13:50.586Z","updated_at":"2025-10-29T09:14:51.166Z","avatar_url":"https://github.com/james2doyle.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# General Doc\n\n\u003e A plugin for [Sublime Text 3](http://sublimetext.com) that creates documentation from it's own config\n\n![demo](demo.gif)\n\n## Summary\n\nThis packages allows you to list an array of symbols and supply a URL that will be used to point to the documentation for that symbol.\n\n### Use Cases\n\nThere are lots of \"languages\" (mostly templating ones) that don't have support for more of the common features of languages that can be statically analysed or run through a [LSP](https://microsoft.github.io/language-server-protocol/).\n\nThis package allows you to provide a nice popup for words that are being hovered over that will link to documentation for that symbol. For languages with lots of keywords and features that don't require being \"analysed\", this can be really helpful.\n\nThis package works by allowing you to define your documentation structure in the plugins settings file so that when hovered words are matched, it will give you a popup with a link to documentation.\n\nYou can provide a single documentation URL for a group of words, or make a group for each word. The documetations are divided into Sublime \"scopes\" so that they are only used on scopes that actually have matching documentation supplied.\n\n## Installation\n\nWith [Package Control](http://wbond.net/sublime_packages/package_control) (look for \"General Doc\"), or just drop the plugin into Sublime Text's Packages folder.\n\n## Configuration\n\nAll configuration is done via the settings file that you can open via the main menu: `Preferences \u003e Package Settings \u003e General Doc \u003e Settings - User`.\n\n### Documentation structure\n\nSee [GeneralDoc.sublime-settings](GeneralDoc.sublime-settings) for an example of the structure.\n\n### Built-in documentation\n\n- [x] HTML (using [MDN Web/HTML/Element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element))\n- [x] Twig (using [twig.symfony.com/doc/2.x](https://twig.symfony.com/doc/2.x/))\n- [x] Liquid (using [shopify.github.io/liquid](https://shopify.github.io/liquid/) or [shopify.dev/docs/liquid](https://shopify.dev/docs/liquid))\n- [ ] more examples to come!\n\n### Debugging\n\nSet `logging` to `true` in the plugin settings to help debug your documentation definition as well as what the plugin is doing:\n\n    {\n        \"logging\": true,\n    }\n\nOpen the Sublime Console (View \u003e Show Console) to see the logging output.\n\n### Customising the browser\n\nBy default, General Doc uses the default system browser. If it doesn't work for you, you can change the browser by setting the `browser` in the `GeneralDoc.sublime-settings`\nfile, to which you can get from the menu.\n\nAnything from [this list](https://docs.python.org/2/library/webbrowser.html#webbrowser.register) will work, for example:\n\n    {\n        \"browser\": \"firefox\"\n    }\n\n**Note for Windows users.** If the browser you want won't open, you might have to specify the full path manually:\n\n    {\n        \"browser\": \"\\\"c:\\\\program files\\\\mozilla firefox\\\\firefox.exe\\\" %s \u0026\"\n    }\n\nTake note of the escaped slashes and the quoting around the name.\n\nThe ampersand at the end is significant - without it the editor will hang and wait for browser to close.\n\n## References\n\n- Packages/Default/symbol.py\n- [leonid-shevtsov/ClickableUrls_SublimeText](https://github.com/leonid-shevtsov/ClickableUrls_SublimeText)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames2doyle%2Fsublime-general-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjames2doyle%2Fsublime-general-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames2doyle%2Fsublime-general-doc/lists"}