In order to build the site locally, you will need Ruby installed (the site is based on Jekyll). The steps to get the site built are:
- Install Ruby
- Install Bundler -
gem install bundler
- Clone this repo
- Initialise and clone the sub-modules -
git submodule init
andgit submodule update
- Download dependencies (gems) -
rake bootstrap
- Build and preview the site with
rake preview
This starts Jekyll running the site at http://localhost:4001/help/resharper/sdk/
- Title case for page headings, both in the page and in the
_SUMMARY.md
file. - Sentence case for sub headings in pages
The following terms are used to refer to standard well known features in the product. They are not normally capitalised, unless otherwise shown.
- Alt+Enter, mono space (should wrap in
<kbd>Alt</kbd>+<kbd>Enter</kbd>
?) - Context action
- Quick-fix
- Code cleanup
- plugin
- Indent of 2. Be conservative with space
- Long lines will scroll horizontally, so don't wrap unnecessarily. However, don't add really long lines either.
- Allow blank lines for clarity
- Comment if necessary, but not for everything