Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/warmdev/SublimeOutline
Outline view for Sublime Text 3
https://github.com/warmdev/SublimeOutline
Last synced: 16 days ago
JSON representation
Outline view for Sublime Text 3
- Host: GitHub
- URL: https://github.com/warmdev/SublimeOutline
- Owner: warmdev
- License: mit
- Created: 2016-09-05T18:22:23.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-02-27T21:31:42.000Z (over 2 years ago)
- Last Synced: 2024-08-01T05:24:03.633Z (3 months ago)
- Language: Python
- Size: 122 KB
- Stars: 65
- Watchers: 9
- Forks: 23
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Outline for Sublime Text 3
### Overview
Inspired by [FileBrowser](https://github.com/aziz/SublimeFileBrowser), this package shows the outline of your file, class/function name list of your code, or table of content/toc of your markdown/LaTeX document in a sidebar-style tab.
### Installation
#### Install via Package Control
This package is available on [Package Control](https://packagecontrol.io/). Search for `Outline`.
#### Manual installation
1. Clone or download this repository to your hard drive using the green `Clone or download` button
2. Rename the cloned or extracted folder to `Outline`. Make sure `outline.py` is at the root of the `Outline` folder.
3. Move the `Outline` folder to your Sublime Text's `Packages` folder. To find the `Packages` folder, click menu `Preferences` > `Browse Packages`.
4. Restart Sublime Text, and press `Ctrl + Shift + P` to select your preferred layout (`Browse Mode`)
### Default layout
The outline tab can be set as a sidebar on the left or right. Press `Ctrl + Shift + P` and select either `Browse Mode: Outline (Left)` or `Browse Mode: Outline (Right)` to set your preferred layout.
If you also use [FileBrowser](https://github.com/aziz/SublimeFileBrowser), you can use both in three different layouts:
* `FileBrowser` left, `Outline` right
* `FileBrowser` top left, `Outline` bottom left
* `FileBrowser` top right, `Outline` bottom right
To use `FileBrowser` and `Outline` together, please close the `FileBrowser` sidebar first and then use the correponding `Browse Mode` command to set the layout, otherwise the `Outline` view may not work as intended.
### Color theme
`Outline` can be configured to use the current editor color scheme. To do so, change the setting below:
```json
"outline_inherit_color_scheme": true
```
`Outline` has two built-in color themes: Bright (default theme) and Dark. To switch to the Dark theme, add the following to your user settings file. Open the user settings file by "Preferences > Package Settings > Outline > Settings" (Sublime Text version 3124 or later), or "Settings - User":
```json
"outline_inherit_color_scheme": false
"color_scheme": "Packages/Outline/outline-Dark.hidden-tmTheme"
```
Remove `-Dark` or remove the entire line to return to the bright theme. To customize your own color theme, see [this issue](https://github.com/warmdev/SublimeOutline/issues/1).
### Outline content and indentation
Outline is updated when you save a file or switch between files.
Content and indentation in the `Outline` tab is controlled by the `Symbol List.tmPreferences` file (file name may differ) corresponding to the syntax of your file.
### Known issue
* This package may not work if you use a multi-column/row layout.
### License
This plugin is licensed under the MIT license.