We started this project to fill the gaps in the Sublime Text official documentation.
Read this guide online for free.
You can follow our progress here and on our public Trello board.
If you find this guide useful, you can treat us to a beer or send a donation our way:
| One-off Tip |
|---|
| ST Undocs Team |
We accept error reports and requests for new content via our issue tracker, and encourage you to send pull requests (but we cannot guarantee they will always be merged).
Please follow our style guidelines as described in CONTRIBUTING.md.
This repository includes a .sublime-project
with predefined settings and a build system
that builds the HTML docs using Sphinx.
In order to build and preview the docs, you'll need Sphinx, which in turn requires Python 2.7. Python 3+ will not work.
pip install sphinx
By default, the docs' preview will display a standard Sphinx theme, but you can install and use ReadTheDocs' theme if you prefer that:
pip install sphinx_rtd_theme
If this theme is available, the build system will pick it up.
After the build is finished,
you can open build/html/index.html
in your browser to see the guide.