Sublime Text 3/4 plugin for quick access to Elixir documentation
- Total 278
- Win 48
- Mac 147
- Linux 83
|Dec 1||Nov 30||Nov 29||Nov 28||Nov 27||Nov 26||Nov 25||Nov 24||Nov 23||Nov 22||Nov 21||Nov 20||Nov 19||Nov 18||Nov 17||Nov 16||Nov 15||Nov 14||Nov 13||Nov 12||Nov 11||Nov 10||Nov 9||Nov 8||Nov 7||Nov 6||Nov 5||Nov 4||Nov 3||Nov 2||Nov 1||Oct 31||Oct 30||Oct 29||Oct 28||Oct 27||Oct 26||Oct 25||Oct 24||Oct 23||Oct 22||Oct 21||Oct 20||Oct 19||Oct 18|
A Sublime Text ¾ plugin for quick navigation to HexDocs documentation for modules in Elixir and in project dependencies.
Installing with Package Control
⌘/Ctrl + Shift + Pto open the command palette.
Package Control: Install Packageand press enter. Then search for
ElixirDocs, select the package and hit enter.
- Open up the command palette with
⌘/Ctrl + Shift + P
- Select the
Elixir Docscommand to see a filterable list of Elixir modules
- Once you've found the module you're interested in, hit enter to navigate to the documentation in your default browser
Finding documented modules is done in Python code and is not exact. It's based on regular expressions which operate under certain assumptions. Because of this, you may not be able to find some modules even though they are documented. You also may find some modules which don't have documentation published on HexDocs.
There is no simple fix for this, to make it better one would need to parse the Elixir code into an AST and use the AST to extract information. Furthermore, one would need a fast way to check whether a module has documentation published on HexDocs.
That being said, this is just a convenience to access (most of) the documentation faster - so I'm not sure it's justified to invest the work in making it 100% correct.
Nested modules are most likely not going to be shown in the dropdown.
Feedback and contributions are very much welcome. That being said, please don't get upset if I don't get back to you for some time on issues and PRs; life happens :)
By contributing you agree for your work to be published under the same license.