Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Sync changes from upstream repository#932

Merged
hubot merged 1 commit intomasterfromupdate-1450306224
Dec 16, 2015
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
524 changes: 524 additions & 0 deletionsLICENSE.txt
View file
Open in desktop

Large diffs are not rendered by default.

111 changes: 58 additions & 53 deletionsREADME.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,43 @@ This is a GitHub API resource built with [Nanoc][nanoc].

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/).

## Setup

Ruby 2.2 is required to build the site.
## Development

GettheNanoc gem, plus kramdown for Markdown parsing:
You can fetchthelatest dependencies by opening the command line and running `script/bootstrap`:

```sh
$ bundle install
``` sh
$ 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.

```sh
$ bundle exec 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`:

``` sh
$ 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 compiled in 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/
Expand DownExpand Up@@ -93,52 +114,36 @@ of commands.

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

## Development

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

``` sh
$ 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`:

``` sh
$ 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 compiled in 5.81s.
```

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

## Deploy

```sh
$ bundle exec rake publish
```

## Licenses

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:

> Content based on
> <a href="https://github.com/github/developer.github.com">developer.github.com</a>
> used under the
> <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>
> license.</a>

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.
2 changes: 1 addition & 1 deletionassets/stylesheets/documentation.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -843,7 +843,7 @@ a .mega-octicon {

.footer-cell li {
display: inline;
margin-right:20px;
margin-right:9px;
list-style: none;
}

Expand Down
3 changes: 1 addition & 2 deletionscontent/changes/2013-08-20-search-api-improvements.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ For example, when [searching for files that have "client" in their path][example
## Better Text Match Metadata

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<a href="https://github.com/rails/rails/issues/11889" data-proofer-ignore>rails/rails#11889</a>:

![Example Issue Title](https://f.cloud.github.com/assets/2988/994632/a84f2888-09af-11e3-9417-4bd92f1f1ed6.png)

Expand DownExpand Up@@ -67,7 +67,6 @@ We appreciate everyone that has provided feedback so far. Please [keep it coming

[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
Expand Down
5 changes: 1 addition & 4 deletionslayouts/footer.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
<div id="footer" >
<div class="lower_footer">
<ul class="footer-cell">
<li><a href="https://github.com/github/developer.github.com#licenses">&copy; <%= Time.now.year %> GitHub, Inc.</a></li>
<li><a href="https://help.github.com/terms-of-service/">Terms</a></li>
<li><a href="https://help.github.com/privacy-policy/">Privacy</a></li>
<li><a href="https://help.github.com/security/">Security</a></li>
Expand All@@ -20,10 +21,6 @@
</ul>
</div>

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

</div><!-- /#footer -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
Expand Down
3 changes: 3 additions & 0 deletionspackage.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,8 @@
"repository": {
"type" : "git",
"url" : "https://github.com/github/help-docs.git"
},
"engines": {
"node": ">= 4.0.0"
}
}
[8]ページ先頭
©2009-2025 Movatter.jp