{"id":17801653,"url":"https://github.com/ubaldot/vim-outline","last_synced_at":"2025-03-17T11:30:49.368Z","repository":{"id":153836499,"uuid":"627301927","full_name":"ubaldot/vim-outline","owner":"ubaldot","description":"A simple outline sketcher.","archived":false,"fork":false,"pushed_at":"2025-02-10T12:51:51.000Z","size":84712,"stargazers_count":19,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T23:28:36.221Z","etag":null,"topics":["python","vim","vim-plugin"],"latest_commit_sha":null,"homepage":"https://www.vim.org/scripts/script.php?script_id=6068","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubaldot.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":"2023-04-13T07:27:53.000Z","updated_at":"2025-02-10T12:51:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"417904ff-787b-48f2-abd0-5e1586441139","html_url":"https://github.com/ubaldot/vim-outline","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubaldot%2Fvim-outline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubaldot%2Fvim-outline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubaldot%2Fvim-outline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubaldot%2Fvim-outline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubaldot","download_url":"https://codeload.github.com/ubaldot/vim-outline/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858576,"owners_count":20359376,"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":["python","vim","vim-plugin"],"created_at":"2024-10-27T12:39:08.517Z","updated_at":"2025-03-17T11:30:49.363Z","avatar_url":"https://github.com/ubaldot.png","language":"Vim Script","funding_links":[],"categories":["Miscellaneous"],"sub_categories":[],"readme":"# vim-outline\n\nA simple outline sketcher for Vim.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"/OutlineDemo.gif\" width=\"60%\" height=\"60%\"\u003e\n\u003c/p\u003e\n\n## Introduction\n\nVim-outline parse your current buffer and slam an outline in a side-window\nbased on a set of regex. That's all!\n\nIf you pass a regex to `:Outline` command, then the tool will have the same\nbehavior as `:global`, but here you can jump back and forth between the\noutline and the original windows. If no regex are passed, then the outline\nwindows is filled depending on the `filetype` (if such a `filetype` is\nsupported).\n\nThe `filetype` outline is far from being perfect, but it gives you a good idea\nof how your buffer is structured. It is perhaps the plugin that I use more!\n\n## Installation\n\nUse any plugin manager or the builtin Vim plugin manager.\n\n## Requirements\n\nVim-outline is written in _Vim9script_, therefore you need at least _Vim 9.0_.\nThat is pretty much all. No ctags, nor LSP servers required.\n\n## Usage\n\n#### Commands\n\n`:OutlineToggle [{regex}]` open/close a side-window that shows an outline of\nyour current buffer based on `{regex}`. If `{regex}` is not passed, then the\noutline window will depends on the current buffer `filetype`.\n\n`:OutlineJump` jump on the outline window. Such a command is handy when you\nhave different windows open in the same tab and you want to jump directly to\nthe outline window with one key-press.\n\n`:OutlineRefresh` update outline \u0026 locate yourself.\n\n#### Mappings\n\n```\n# Default mappings\nnmap \u003csilent\u003e \u003cF8\u003e \u003cPlug\u003eOutlineToggle\nnmap \u003csilent\u003e \u003cleader\u003el \u003cPlug\u003eOutlineRefresh\nnmap \u003csilent\u003e \u003cleader\u003eo \u003cPlug\u003eOutlineGoToOutline\n```\n\nFeel free to change them at your convenience.\n\n## Configuration\n\nThe basic configuration variables are the following:\n\n```# Default values\ng:outline_buf_name = \"Outline!\"\ng:outline_win_size = \u0026columns / 4\ng:outline_enable_highlight = true\n```\n\nSee `:h OutlineConfiguration` for additional configuration variables.\n\n## Create arbitrary outlines\n\nYou can create arbitrary outlines for different `filetypes` in a very easy\nway. You just have to write your own regex. For example, assume that you want\nto create a custom outline for `cpp` filetypes:\n\n#### Step 1\n\nAdd the following lines to your `.vimrc`\n\n```\n    extend(g:outline_include_before_exclude, {cpp: true})\n    extend(g:outline_pattern_to_include, {cpp: ['\u003cKEEP-ME!\u003e']})\n```\n\n#### Step 3\n\nComment each line that you want to keep in the outline with `// \u003cKEEP-ME!\u003e`.\n\nAt this point, call `:OutlineToggle` and see what happens. Jumps and\nlocalization functions should work automatically.\n\n## Help\n\n`:h outline.txt`\n\n## Contributing\n\nContributions are more than welcome! See `:h OutlineContributing` for more\ninfo.\n\n## License\n\nBSD3-Clause.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubaldot%2Fvim-outline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubaldot%2Fvim-outline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubaldot%2Fvim-outline/lists"}