Snippets for Sublime Text to speed up the process of writing Readme files, supporting Markdown, reStructuredText and Textile.
- Make sure you already have Package Control installed
- Choose “Install Package” from the Command Palette (Super+Shift+p)
- Type “Readme Helper” and press Enter
- Change to your Sublime Text
Packages
directory - Clone repository
git clone https://github.com/idleberg/Readme-Helper.git 'Readme Helper'
- Download the latest stable release
- Unzip the archive to your Sublime Text
Packages
directory
By default, command completion should be enabled in all Sublime Text versions. If the completion popup doesn't show while typing one of the following commands, you can force showing it using Ctrl+Space
or by adding the right scope to your user settings under auto_complete_selector
.
All command completions are prefixed with rm
. Thanks to Sublime Text fuzzy search, you can use shortcuts such as rmppl
to trigger rm-paypal
or rmsf
to trigger rm-sourceforge
.
See below for a full list of available commands.
rm-scaffold_sublimetext
instructions for Sublime Text Package Control
rm-scaffold_grunt
instructions for a Grunt package
rm-scaffold_node
(very basic) instructions for the Node Package Manager
rm-scaffold_wordpress
a readme for a Wordpress plugin
Trigger | Badge | Example |
---|---|---|
rm-bitdeli |
BitDeli | |
rm-bower_version |
Bower | |
rm-cocoapod_version |
CocoaPod | |
rm-codeclimate |
Code Climate | n/a |
rm-coveralls |
Coverage | |
rm-cpan_version |
Perl | |
rm-david_dev |
devDepencies | |
rm-david |
Depencies | |
rm-flattr_icon |
Flattr (icon) | |
rm-flattr |
Flattr (badge) | |
rm-gem_version |
gem version | |
rm-github_follow_count |
GitHub (follow count) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&type=follow&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="165" height="20"></iframe> |
rm-github_follow |
GitHub (follow button) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&type=follow" allowtransparency="true" frameborder="0" scrolling="0" width="132" height="20"></iframe> |
rm-github_fork_count |
GitHub (fork count) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&repo=Readme-Helper&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe> |
rm-github_fork |
GitHub (fork) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&repo=Readme-Helper&type=fork" allowtransparency="true" frameborder="0" scrolling="0" width="53" height="20"></iframe> |
rm-github_star_count |
GitHub (star count) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&repo=Readme-Helper&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe> |
rm-github_star_large_count |
GitHub (large star count) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&repo=Readme-Helper&type=watch&count=true&size=large" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe> |
rm-github_star |
GitHub (star) | <iframe src="http://ghbtns.com/github-btn.html?user=idleberg&repo=github-buttons&type=watch" allowtransparency="true" frameborder="0" scrolling="0" width="62" height="20"></iframe> |
rm-github_version |
GitHub | |
rm-gitter |
Gitter | ![Gitter](https://badges.gitter.im/Join Chat.svg) |
rm-grunt |
Grunt | |
rm-landscape |
Landscape | n/a |
rm-npm_version |
npm module | |
rm-nuget_version |
NuGet | |
rm-paypal |
Paypal | |
rm-php_version |
PHP | |
rm-pypi_version |
PyPI | |
rm-travis |
Travis |
To extend support for Shields.io badges, please install the Badges package!
Trigger | Target | Example |
---|---|---|
rm-bitbucket_repo |
Bitbucket repository | https://bitbucket.org/user/repository |
rm-github_repo |
GitHub repository | https://github.com/user/repository |
rm-github_user |
GitHub user profile | https://github.com/user |
rm-github_webpage |
GitHub web page | https://user.github.io/repository |
rm-gitorious_repo |
Gitorious repository | https://gitorious.org/user/repository |
rm-googlecode |
Google Code project | https://code.google.com/p/project |
rm-heroku_webpage |
Heroku web page | http://example.herokuapp.com |
rm-sourceforge_webpage |
SourceForge web page | http://example.sourceforge.net |
rm-sourceforge |
SourceForge project page | https://sourceforge.net/projects/example |
If you'd like to contribute to this project, feel invited to commit to this repository!
This work is licensed under the The MIT License.
You are welcome support this project using Flattr or Bitcoin 17CXJuPsmhuTzFV2k4RKYwpEHVjskJktRd