README.md
[](https://www.npmjs.com/package/hirse.outline-list)
[](https://github.com/Hirse/brackets-outline-list/actions/workflows/master.yml)
[](https://codecov.io/github/Hirse/brackets-outline-list)
<a href="https://brackets.io"><img src="https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/brackets.png" alt="Brackets" title="Brackets" align="left" /></a>
<a href="https://phcode.dev"><img src="https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/phoenix.png" alt="Phoenix" title="Phoenix" align="left" /></a>
# Outline List
Extension for [Brackets][Brackets] and [Phoenix][Phoenix] to display a list of the functions or definitions in the currently opened document. Settings for parameters and anonymous functions. See [features](#features) for a list of supported languages.
## Screenshots
*Outline for JavaScript*
*Outline for CSS, HTML and Markdown in the Sidebar*
## Features
* List Functions or Definitions in the current document
* Jump to declaration from the Outline List
* Show Outline List in the sidebar or next to the toolbar
* Differentiate between types easily by showing different icons
* Toggle sorting of Outline List
* Toggle anonymous function
* Toggle function arguments
### Language features:
| | Parsing | Sorting | Indentation | Arguments | Unnamed |
|------------------------------------|--------------|:------------------:|:------------------:|:------------------:|:------------------:|
| CSS, SCSS, LESS | PostCSS | :heavy_check_mark: | :heavy_check_mark: | :no_entry_sign: | :no_entry_sign: |
| CoffeeScript | RegExp | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: |
| Haxe | RegExp | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: |
| Pug (Jade) | RegExp | :no_entry_sign: | :x: | :x: | :no_entry_sign: |
| JavaScript, JSX | Espree | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Markdown, GitHub-Flavored-Markdown | RegExp | :heavy_check_mark: | :no_entry_sign: | :no_entry_sign: | :no_entry_sign: |
| PHP | php-parser | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Python | RegExp | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Ruby | RegExp | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: |
| Stylus | RegExp | :x: | :x: | :no_entry_sign: | :no_entry_sign: |
| XML, HTML, SVG | htmlparser2 | :no_entry_sign: | :heavy_check_mark: | :heavy_check_mark: | :no_entry_sign: |
## Installation
### Latest Release
To install the latest _release_ of this extension use the built-in [Extension Manager][Extension Manager] which downloads the extension from the [extension registry][Brackets Extension Registry].
### Latest Commit
To install the latest _commit_ of this extension use the built-in [Extension Manager][Extension Manager] which has a function to `Install from URL...` using this link: https://github.com/Hirse/brackets-outline-list/archive/master.zip.
## License
Outline List is licensed under the [MIT license][MIT].
Used thirdparty software:
* [Espree][Espree] is licensed under the [BSD 2-Clause License][BSD-2-Clause]
* [htmlparser2][htmlparser2] is licensed under the [MIT license][MIT]
* [Ionicons][Ionicons] is licensed under the [MIT license][MIT]
* [PostCSS Safe Parser][postcss-safe-parser] is licensed under the [MIT license][MIT]
* [php-parser][php-parser] is licensed under the [BSD-3-Clause license][BSD-3-Clause]
* [Promise Polyfill][promise-polyfill] is licensed under the [MIT license][MIT]
[Brackets]: https://brackets.io
[Phoenix]: https://phcode.dev
[Extension Manager]: https://github.com/adobe/brackets/wiki/Brackets-Extensions
[Brackets Extension Registry]: https://registry.brackets.io
[Espree]: https://github.com/eslint/espree
[htmlparser2]: https://github.com/fb55/htmlparser2
[Ionicons]: http://ionicons.com
[postcss-safe-parser]: https://github.com/postcss/postcss-safe-parser
[php-parser]: https://github.com/glayzzle/php-parser
[promise-polyfill]: https://github.com/taylorhakes/promise-polyfill
[BSD-2-Clause]: https://opensource.org/licenses/BSD-2-Clause
[BSD-3-Clause]: https://opensource.org/licenses/BSD-3-Clause
[MIT]: http://opensource.org/licenses/MIT