All submissions are welcome. To submit a change, fork this repo, commit your changes, and send us a[pull request](http://help.github.com/send-pull-requests/).

Ruby 2.2 is required to build the site.

GettheNanoc gem, plus kramdown for Markdown parsing:

You can fetchthelatest dependencies by opening the command line and running`script/bootstrap`:

$ bundle install

$ script/bootstrap

==> Installing gem dependencies…

==> Installing npm dependencies…

Youcanseetheavailable commands with Nanoc:

You'll need Ruby and Node installed on your system. The required versions for each of these languagescanbe found inthe*.ruby-version* and*package.json* files, respectively.

$ bundleexec nanoc -h

You can run`bundle exec rake build` to generate the site, but it's often more useful

to simply build the server*and* start the site at the same time.

Nanoc compiles the site into static files living in`output`. It's

smart enough not to try to compile unchanged files.

You can start the site with`script/server`:

$ script/server

Loading site data...

Compiling site...

create [0.28s] output/index.html

create [1.31s] output/v3/gists/comments/index.html

identical [1.92s] output/v3/gists/index.html

identical [0.25s] output/v3/issues/comments/index.html

update [0.99s] output/v3/issues/labels/index.html

update [0.05s] output/v3/index.html

…

Site compiledin 5.81s.

The site is hosted at`http://localhost:4000`.

Nanoc has[some nice documentation](http://nanoc.ws/docs/tutorial/) to get you started. Though if you're mainly concerned with editing or adding content, you won't need to know much about Nanoc.

[nanoc]:http://nanoc.ws/

For more information, see[the reference documentation](https://github.com/gjtorikian/extended-markdown-filter#command-line-highlighting).

You can fetch the latest dependencies by opening the command line and running`script/bootstrap`:

$ script/bootstrap

==> Installing gem dependencies…

==> Installing npm dependencies…

You'll need Ruby 2.2.3 and at least Node v4.x.

You can run`bundle exec rake build` to generate the site, but it's often more useful

to simply build the server*and* start the site at the same time.

Nanoc compiles the site into static files living in`./output`. It's

smart enough not to try to compile unchanged files.

You can start the site with`script/server`:

$ script/server

Loading site data...

Compiling site...

identical [0.00s] output/css/960.css

identical [0.00s] output/css/pygments.css

identical [0.00s] output/css/reset.css

identical [0.00s] output/css/styles.css

identical [0.00s] output/css/uv_active4d.css

update [0.28s] output/index.html

update [1.31s] output/v3/gists/comments/index.html

update [1.92s] output/v3/gists/index.html

update [0.25s] output/v3/issues/comments/index.html

update [0.99s] output/v3/issues/labels/index.html

update [0.49s] output/v3/issues/milestones/index.html

update [0.50s] output/v3/issues/index.html

update [0.05s] output/v3/index.html

…

Site compiledin 5.81s.

The site is hosted at`http://localhost:4000`.

$ bundleexec rake publish

The code to generate the site (everything excluding the assets, content,

and layouts directories) as well as the code samples on the site are

licensed under

[CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode).

CC0 waives all copyright restrictions but does not grant you any trademark

permissions.

Site content (everything in the assets, content, and layouts directories,

excluding files under open source licenses individually marked) is licensed

under[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0

gives you permission to use content for almost any purpose but does not grant

you any trademark permissions, so long as you note the license and give credit,

such as follows:

This means you can use the code and content in this repository except for

GitHub trademarks in your own projects.

When you contribute to this repository you are doing so under the above

licenses.

.footer-cellli {

display: inline;

margin-right:20px;

margin-right:9px;

list-style: none;

}

Before today, the API applied HTML entity encoding to all`fragment` data.

For example, imagine your search returns an issue like[rails/rails#11889][example-issue]:

For example, imagine your search returns an issue like<ahref="https://github.com/rails/rails/issues/11889"data-proofer-ignore>rails/rails#11889</a>:


[contact]:https://github.com/contact?form[subject]=New+Search+API

[code-text-matches]:/v3/search/#highlighting-code-search-results

[example-issue]:https://github.com/rails/rails/issues/11889

[example-path-search]:https://github.com/search?q=%40octokit%2Foctokit.rb+in%3Apath+client&type=Code

[original-search-api-announcement]:/changes/2013-07-19-preview-the-new-search-api/

[preview-period]:/changes/2013-07-19-preview-the-new-search-api/#preview-period

<divid="footer">

<divclass="lower_footer">

<ulclass="footer-cell">

<li><ahref="https://github.com/github/developer.github.com#licenses">&copy;<%= Time.now.year %> GitHub, Inc.</a></li>

<li><ahref="https://help.github.com/terms-of-service/">Terms</a></li>

<li><ahref="https://help.github.com/privacy-policy/">Privacy</a></li>

<li><ahref="https://help.github.com/security/">Security</a></li>

<divclass="wrapper">

<p>Design &copy;<%= Time.now.year %> Copyright<%= Time.now.year %> GitHub, Inc.</p>

"repository": {

"type" :"git",

"url" :"https://github.com/github/help-docs.git"

},

"engines": {

"node":">= 4.0.0"

}

}