|
1 | | -IyBkZXZlbG9wZXIuZ2l0aHViLmNvbQoKKipOT1RFOiBUaGUgZGV2ZWxvcGVy |
2 | | -LmdpdGh1Yi5jb20gd2Vic2l0ZSBpcyBubyBsb25nZXIgb3Blbi1zb3VyY2Uu |
3 | | -KioKCldlIGhhdmUgbW92ZWQgdGhpcyByZXBvc2l0b3J5IGludG8gW291ciBn |
4 | | -aXRodWItYXJjaGl2ZSBvcmdhbml6YXRpb25dKGh0dHBzOi8vZ2l0aHViLmNv |
5 | | -bS9naXRodWItYXJjaGl2ZSkgdG8gc2lnbmlmeSB0aGF0IHdlIGFyZSBubyBs |
6 | | -b25nZXIgYWNjZXB0aW5nIG9wZW4tc291cmNlIGNvbnRyaWJ1dGlvbnMgdG8g |
7 | | -dGhpcyByZXBvc2l0b3J5LiBXZSB3YW50IHRvIHRoYW5rIHRoZSBodW5kcmVk |
8 | | -cyBvZiBjb250cmlidXRvcnMgZm9yIHRoZWlyIGFzc2lzdGFuY2Ugb3ZlciB0 |
9 | | -aGUgeWVhcnMuCgpUaGUgZGVjaXNpb24gdG8gY2xvc2Utc291cmNlIHRoZSBz |
10 | | -aXRlIHN0ZW1zIGZyb20gYSB2YXJpZXR5IG9mIHJlYXNvbnM6CgoxLiBXZSBh |
11 | | -Y3R1YWxseSBhbHJlYWR5IF9oYXZlXyBhIGNsb3NlLXNvdXJjZWQgc2l0ZSwg |
12 | | -d2hpY2ggaXMgd2hlcmUgd2Ugd3JvdGUgZG9jdW1lbnRhdGlvbiBmb3IgdW5y |
13 | | -ZWxlYXNlZCBmZWF0dXJlcy4gV2UgZGVzaWduZWQgYWRkaXRpb25hbCB0b29s |
14 | | -aW5nIHRvIHN1cHBvcnQgdGhpcyB3b3JrZmxvdywgYnV0IHVwZGF0aW5nIHRo |
15 | | -ZSBkb2N1bWVudGF0aW9uIGlzIGEgcHJvY2VzcyB3ZSdkIGxpa2UgdG8gc2lt |
16 | | -cGxpZnkuCjIuIFdlIGJlbGlldmUgdGhhdCBhbnkgb3Blbi1zb3VyY2UgcHJv |
17 | | -amVjdOKAlGJlIGl0IGRvY3VtZW50YXRpb24gb3Igc29mdHdhcmXigJRvdWdo |
18 | | -dCB0byBoYXZlIGRlZGljYXRlZCBtYWludGFpbmVycy4gSXQgYmVjYW1lIGRp |
19 | | -ZmZpY3VsdCB0byBrZWVwIHRoaXMgcmVwb3NpdG9yeSBvcGVuLXNvdXJjZSBi |
20 | | -ZWNhdXNlIGl0IHdhcyBtYWludGFpbmVkIGJ5IHRoZSBiZXN0IGVmZm9ydHMg |
21 | | -b2YgYSBzbWFsbCBncm91cCBvZiBwZW9wbGUuIENsb3NpbmcgdGhlIHNpdGUg |
22 | | -YWxsb3dzIHVzIHRvIGZvY3VzIG9uIHdoYXQncyBpbXBvcnRhbnQsIHdpdGhv |
23 | | -dXQgZmVlbGluZyBndWlsdHkgYXQgbWlzc2luZyByZXZpZXdzIGZyb20gb3Bl |
24 | | -bi1zb3VyY2UgY29udHJpYnV0b3JzLgoKV2UgdGhpbmsgdGhhdCB0aGUgdG9v |
25 | | -bGluZyB3ZSB1c2VkIHRvIGJ1aWxkIHRoaXMgc2l0ZSBpcyBwcmV0dHkgaW50 |
26 | | -ZXJlc3RpbmcsIHNvIHdlJ3JlIG5vdCBnZXR0aW5nIHJpZCBvZiBldmVyeXRo |
27 | | -aW5nLiBXZSBob3BlIHRoYXQgd2hhdCByZW1haW5zIGNhbiBiZSB1c2VkIGFz |
28 | | -IGEgc291cmNlIG9mIGluc3BpcmF0aW9uIGZvciB5b3VyIG93biBzdGF0aWMg |
29 | | -c2l0ZS4KCklmIHlvdSBmaW5kIHNvbWV0aGluZyB0aGF0IG5lZWRzIHRvIGJl |
30 | | -IGZpeGVkLCB5b3UgY2FuIGFsd2F5cyBbY29udGFjdCBvdXIgdGVycmlmaWMg |
31 | | -U3VwcG9ydCB0ZWFtXShodHRwczovL2dpdGh1Yi5jb20vY29udGFjdD9mb3Jt |
32 | | -JTVCc3ViamVjdCU1RD1Nb3ZpbmcrZGV2ZWxvcGVyLmdpdGh1Yi5jb20rdG8r |
33 | | -Z2l0aHViLWFyY2hpdmUpLgoKVGhhbmsgeW91IQoKKiAqICoKClRoaXMgd2Fz |
34 | | -IHRoZSBHaXRIdWIgQVBJIGRvY3VtZW50YXRpb24sIGJ1aWx0IHdpdGggW05h |
35 | | -bm9jXVtuYW5vY10uCgojIyBEZXZlbG9wbWVudAoKWW91IGNhbiBmZXRjaCB0 |
36 | | -aGUgbGF0ZXN0IGRlcGVuZGVuY2llcyBieSBvcGVuaW5nIHRoZSBjb21tYW5k |
37 | | -IGxpbmUgYW5kIHJ1bm5pbmcgYHNjcmlwdC9ib290c3RyYXBgOgoKYGBgIHNo |
38 | | -CiQgc2NyaXB0L2Jvb3RzdHJhcAo9PT4gSW5zdGFsbGluZyBnZW0gZGVwZW5k |
39 | | -ZW5jaWVz4oCmCj09PiBJbnN0YWxsaW5nIG5wbSBkZXBlbmRlbmNpZXPigKYK |
40 | | -YGBgCgpZb3UnbGwgbmVlZCBSdWJ5IGFuZCBOb2RlIGluc3RhbGxlZCBvbiB5 |
41 | | -b3VyIHN5c3RlbS4gVGhlIHJlcXVpcmVkIHZlcnNpb25zIGZvciBlYWNoIG9m |
42 | | -IHRoZXNlIGxhbmd1YWdlcyBjYW4gYmUgZm91bmQgaW4gdGhlICoucnVieS12 |
43 | | -ZXJzaW9uKiBhbmQgKnBhY2thZ2UuanNvbiogZmlsZXMsIHJlc3BlY3RpdmVs |
44 | | -eS4KCllvdSBjYW4gcnVuIGBidW5kbGUgZXhlYyByYWtlIGJ1aWxkYCB0byBn |
45 | | -ZW5lcmF0ZSB0aGUgc2l0ZSwgYnV0IGl0J3Mgb2Z0ZW4gbW9yZSB1c2VmdWwK |
46 | | -dG8gc2ltcGx5IGJ1aWxkIHRoZSBzZXJ2ZXIgKmFuZCogc3RhcnQgdGhlIHNp |
47 | | -dGUgYXQgdGhlIHNhbWUgdGltZS4KCk5hbm9jIGNvbXBpbGVzIHRoZSBzaXRl |
48 | | -IGludG8gc3RhdGljIGZpbGVzIGxpdmluZyBpbiBgb3V0cHV0YC4gIEl0J3MK |
49 | | -c21hcnQgZW5vdWdoIG5vdCB0byB0cnkgdG8gY29tcGlsZSB1bmNoYW5nZWQg |
50 | | -ZmlsZXMuCgpZb3UgY2FuIHN0YXJ0IHRoZSBzaXRlIHdpdGggYHNjcmlwdC9z |
51 | | -ZXJ2ZXJgOgoKYGBgIHNoCiQgc2NyaXB0L3NlcnZlcgpMb2FkaW5nIHNpdGUg |
52 | | -ZGF0YS4uLgpDb21waWxpbmcgc2l0ZS4uLgogICBjcmVhdGUgICAgIFswLjI4 |
53 | | -c10gIG91dHB1dC9pbmRleC5odG1sCiAgIGNyZWF0ZSAgICAgWzEuMzFzXSAg |
54 | | -b3V0cHV0L3YzL2dpc3RzL2NvbW1lbnRzL2luZGV4Lmh0bWwKICAgaWRlbnRp |
55 | | -Y2FsICBbMS45MnNdICBvdXRwdXQvdjMvZ2lzdHMvaW5kZXguaHRtbAogICBp |
56 | | -ZGVudGljYWwgIFswLjI1c10gIG91dHB1dC92My9pc3N1ZXMvY29tbWVudHMv |
57 | | -aW5kZXguaHRtbAogICB1cGRhdGUgICAgIFswLjk5c10gIG91dHB1dC92My9p |
58 | | -c3N1ZXMvbGFiZWxzL2luZGV4Lmh0bWwKICAgdXBkYXRlICAgICBbMC4wNXNd |
59 | | -ICBvdXRwdXQvdjMvaW5kZXguaHRtbAogICDigKYKClNpdGUgY29tcGlsZWQg |
60 | | -aW4gNS44MXMuCmBgYAoKVGhlIHNpdGUgaXMgaG9zdGVkIGF0IGBodHRwOi8v |
61 | | -bG9jYWxob3N0OjQwMDBgLgoKTmFub2MgaGFzIFtzb21lIG5pY2UgZG9jdW1l |
62 | | -bnRhdGlvbl0oaHR0cDovL25hbm9jLndzL2RvY3MvdHV0b3JpYWwvKSB0byBn |
63 | | -ZXQgeW91IHN0YXJ0ZWQuICBUaG91Z2ggaWYgeW91J3JlIG1haW5seSBjb25j |
64 | | -ZXJuZWQgd2l0aCBlZGl0aW5nIG9yIGFkZGluZyBjb250ZW50LCB5b3Ugd29u |
65 | | -J3QgbmVlZCB0byBrbm93IG11Y2ggYWJvdXQgTmFub2MuCgpbbmFub2NdOiBo |
66 | | -dHRwOi8vbmFub2Mud3MvCgojIyMgRW50ZXJwcmlzZQoKVG8gZ2VuZXJhdGUg |
67 | | -dGhlIGAvZW50ZXJwcmlzZWAgdmVyc2lvbnMsIHBhc3MgaW4gdGhlIEVudGVy |
68 | | -cHJpc2UgdmVyc2lvbiB0byBgc2NyaXB0L3NlcnZlcmAuIEZvciBleGFtcGxl |
69 | | -OgoKYGBgIHNoCiQgc2NyaXB0L3NlcnZlciAyLjYKYGBgCgpOb3RlIHRoYXQg |
70 | | -bGl2ZSByZWxvYWRpbmcgaXMgbm90IGF2YWlsYWJsZSBmb3IgRW50ZXJwcmlz |
71 | | -ZSBkb2N1bWVudGF0aW9uLgoKIyMgU3R5bGVndWlkZQoKTm90IHN1cmUgaG93 |
72 | | -IHRvIHN0cnVjdHVyZSB0aGUgZG9jcz8gIEhlcmUncyB3aGF0IHRoZSBzdHJ1 |
73 | | -Y3R1cmUgb2YgdGhlCkFQSSBkb2NzIHNob3VsZCBsb29rIGxpa2U6CgogICAg |
74 | | -IyBBUEkgdGl0bGUKCiAgICB7OnRvY30KCiAgICAjIyBBUEkgZW5kcG9pbnQg |
75 | | -dGl0bGUKCiAgICAgICAgW1ZFUkJdIC9wYXRoL3RvL2VuZHBvaW50CgogICAg |
76 | | -IyMjIFBhcmFtZXRlcnMKCiAgICBOYW1lIHwgVHlwZSB8IERlc2NyaXB0aW9u |
77 | | -CiAgICAtLS0tLXwtLS0tLS18LS0tLS0tLS0tLS0tLS0KICAgIGBuYW1lYHxg |
78 | | -dHlwZWAgfCBEZXNjcmlwdGlvbi4KCiAgICAjIyMgSW5wdXQgKHJlcXVlc3Qg |
79 | | -SlNPTiBib2R5KQoKICAgIE5hbWUgfCBUeXBlIHwgRGVzY3JpcHRpb24KICAg |
80 | | -IC0tLS0tfC0tLS0tLXwtLS0tLS0tLS0tLS0tLQogICAgYG5hbWVgfGB0eXBl |
81 | | -YCB8IERlc2NyaXB0aW9uLgoKICAgICMjIyBSZXNwb25zZQoKICAgIDwlPSBo |
82 | | -ZWFkZXJzIDIwMCwgOnBhZ2luYXRpb24gPT4gZGVmYXVsdF9wYWdpbmF0aW9u |
83 | | -X3JlbHMsICdYLUN1c3RvbS1IZWFkZXInID0+ICJ2YWx1ZSIgJT4KICAgIDwl |
84 | | -PSBqc29uIDpyZXNvdXJjZV9uYW1lICU+CgoqKk5vdGUqKjogV2UncmUgdXNp |
85 | | -bmcgW0tyYW1kb3duIE1hcmtkb3duIGV4dGVuc2lvbnNdKGh0dHA6Ly9rcmFt |
86 | | -ZG93bi5nZXR0YWxvbmcub3JnL3N5bnRheC5odG1sKSwgc3VjaCBhcyBkZWZp |
87 | | -bml0aW9uIGxpc3RzLgoKIyMjIEpTT04gUmVzcG9uc2VzCgpXZSBzcGVjaWZ5 |
88 | | -IHRoZSBKU09OIHJlc3BvbnNlcyBpbiBSdWJ5IHNvIHRoYXQgd2UgZG9uJ3Qg |
89 | | -aGF2ZSB0byB3cml0ZQp0aGVtIGJ5IGhhbmQgYWxsIG92ZXIgdGhlIGRvY3Mu |
90 | | -ICBZb3UgY2FuIHJlbmRlciB0aGUgSlNPTiBmb3IgYSByZXNvdXJjZQpsaWtl |
91 | | -IHRoaXM6CgpgYGBlcmIKPCU9IGpzb24gOmlzc3VlICU+CmBgYAoKVGhpcyBs |
92 | | -b29rcyB1cCBgR2l0SHViOjpSZXNvdXJjZXM6OklTU1VFYCBpbiBgbGliL3Jl |
93 | | -c291cmNlcy5yYmAuCgpTb21lIGFjdGlvbnMgcmV0dXJuIGFycmF5cy4gIFlv |
94 | | -dSBjYW4gbW9kaWZ5IHRoZSBKU09OIGJ5IHBhc3NpbmcgYSBibG9jazoKCmBg |
95 | | -YGVyYgo8JT0ganNvbig6aXNzdWUpIHsgfGhhc2h8IFtoYXNoXSB9ICU+CmBg |
96 | | -YAoKVGhlcmUgaXMgYWxzbyBhIHJha2UgdGFzayBmb3IgZ2VuZXJhdGluZyBK |
97 | | -U09OIGZpbGVzIGZyb20gdGhlIHNhbXBsZSByZXNwb25zZXMgaW4gdGhlIGRv |
98 | | -Y3VtZW50YXRpb246CgpgYGAgc2gKJCByYWtlIGdlbmVyYXRlX2pzb25fZnJv |
99 | | -bV9yZXNwb25zZXMKYGBgCgpUaGUgZ2VuZXJhdGVkIGZpbGVzIHdpbGwgZW5k |
100 | | -IHVwIGluICpqc29uLWR1bXAvKi4KCiMjIyBUZXJtaW5hbCBibG9ja3MKCllv |
101 | | -dSBjYW4gc3BlY2lmeSB0ZXJtaW5hbCBibG9ja3MgYnkgdXNpbmcgdGhlIGBj |
102 | | -b21tYW5kLWxpbmVgIHN5bnRheCBoaWdobGlnaHRpbmcuCgogICAgYGBgIGNv |
103 | | -bW1hbmQtbGluZQogICAgJCBjdXJsIGZvb2JhcgogICAgYGBgCgpZb3UgY2Fu |
104 | | -IHVzZSBjZXJ0YWluIGNoYXJhY3RlcnMsIGxpa2UgYCRgIGFuZCBgI2AsIHRv |
105 | | -IGVtcGhhc2l6ZSBkaWZmZXJlbnQgcGFydHMKb2YgY29tbWFuZHMuCgogICAg |
106 | | -YGBgIGNvbW1hbmQtbGluZQogICAgIyBjYWxsIGZvb2JhcgogICAgJCBjdXJs |
107 | | -IDxlbT5mb29iYXI8ZW0+CiAgICAuLi4uCiAgICBgYGAKCkZvciBtb3JlIGlu |
108 | | -Zm9ybWF0aW9uLCBzZWUgW3RoZSByZWZlcmVuY2UgZG9jdW1lbnRhdGlvbl0o |
109 | | -aHR0cHM6Ly9naXRodWIuY29tL2dqdG9yaWtpYW4vZXh0ZW5kZWQtbWFya2Rv |
110 | | -d24tZmlsdGVyI2NvbW1hbmQtbGluZS1oaWdobGlnaHRpbmcpLgoKIyMgTGlj |
111 | | -ZW5zZXMKClRoZSBjb2RlIHRvIGdlbmVyYXRlIHRoZSBzaXRlIChldmVyeXRo |
112 | | -aW5nIGV4Y2x1ZGluZyB0aGUgYXNzZXRzLCBjb250ZW50LAphbmQgbGF5b3V0 |
113 | | -cyBkaXJlY3RvcmllcykgYXMgd2VsbCBhcyB0aGUgY29kZSBzYW1wbGVzIG9u |
114 | | -IHRoZSBzaXRlIGFyZQpsaWNlbnNlZCB1bmRlcgpbQ0MwLTEuMF0oaHR0cHM6 |
115 | | -Ly9jcmVhdGl2ZWNvbW1vbnMub3JnL3B1YmxpY2RvbWFpbi96ZXJvLzEuMC9s |
116 | | -ZWdhbGNvZGUpLgpDQzAgd2FpdmVzIGFsbCBjb3B5cmlnaHQgcmVzdHJpY3Rp |
117 | | -b25zIGJ1dCBkb2VzIG5vdCBncmFudCB5b3UgYW55IHRyYWRlbWFyawpwZXJt |
118 | | -aXNzaW9ucy4KClNpdGUgY29udGVudCAoZXZlcnl0aGluZyBpbiB0aGUgYXNz |
119 | | -ZXRzLCBjb250ZW50LCBhbmQgbGF5b3V0cyBkaXJlY3RvcmllcywKZXhjbHVk |
120 | | -aW5nIGZpbGVzIHVuZGVyIG9wZW4gc291cmNlIGxpY2Vuc2VzIGluZGl2aWR1 |
121 | | -YWxseSBtYXJrZWQpIGlzIGxpY2Vuc2VkCnVuZGVyIFtDQy1CWS00LjBdKGh0 |
122 | | -dHBzOi8vY3JlYXRpdmVjb21tb25zLm9yZy9saWNlbnNlcy9ieS80LjAvKS4g |
123 | | -Q0MtQlktNC4wCmdpdmVzIHlvdSBwZXJtaXNzaW9uIHRvIHVzZSBjb250ZW50 |
124 | | -IGZvciBhbG1vc3QgYW55IHB1cnBvc2UgYnV0IGRvZXMgbm90IGdyYW50Cnlv |
125 | | -dSBhbnkgdHJhZGVtYXJrIHBlcm1pc3Npb25zLCBzbyBsb25nIGFzIHlvdSBu |
126 | | -b3RlIHRoZSBsaWNlbnNlIGFuZCBnaXZlIGNyZWRpdCwKc3VjaCBhcyBmb2xs |
127 | | -b3dzOgoKPiBDb250ZW50IGJhc2VkIG9uCj4gPGEgaHJlZj0iaHR0cHM6Ly9n |
128 | | -aXRodWIuY29tL2dpdGh1Yi9kZXZlbG9wZXIuZ2l0aHViLmNvbSI+ZGV2ZWxv |
129 | | -cGVyLmdpdGh1Yi5jb208L2E+Cj4gdXNlZCB1bmRlciB0aGUKPiA8YSBocmVm |
130 | | -PSJodHRwczovL2NyZWF0aXZlY29tbW9ucy5vcmcvbGljZW5zZXMvYnkvNC4w |
131 | | -LyI+Q0MtQlktNC4wPC9hPgo+IGxpY2Vuc2UuPC9hPgoKVGhpcyBtZWFucyB5 |
132 | | -b3UgY2FuIHVzZSB0aGUgY29kZSBhbmQgY29udGVudCBpbiB0aGlzIHJlcG9z |
133 | | -aXRvcnkgZXhjZXB0IGZvcgpHaXRIdWIgdHJhZGVtYXJrcyBpbiB5b3VyIG93 |
134 | | -biBwcm9qZWN0cy4KCldoZW4geW91IGNvbnRyaWJ1dGUgdG8gdGhpcyByZXBv |
135 | | -c2l0b3J5IHlvdSBhcmUgZG9pbmcgc28gdW5kZXIgdGhlIGFib3ZlCmxpY2Vu |
136 | | -c2VzLgo= |
| 1 | +# developer.github.com |
| 2 | + |
| 3 | +**NOTE: The developer.github.com website is no longer open-source.** |
| 4 | + |
| 5 | +We have moved this repository into [our github-archive organization](https://github.com/github-archive) to signify that we are no longer accepting open-source contributions to this repository. We want to thank the hundreds of contributors for their assistance over the years. |
| 6 | + |
| 7 | +The decision to close-source the site stems from a variety of reasons: |
| 8 | + |
| 9 | +1. We actually already _have_ a close-sourced site, which is where we wrote documentation for unreleased features. We designed additional tooling to support this workflow, but updating the documentation is a process we'd like to simplify. |
| 10 | +2. We believe that any open-source project—be it documentation or software—ought to have dedicated maintainers. It became difficult to keep this repository open-source because it was maintained by the best efforts of a small group of people. Closing the site allows us to focus on what's important, without feeling guilty at missing reviews from open-source contributors. |
| 11 | + |
| 12 | +We think that the tooling we used to build this site is pretty interesting, so we're not getting rid of everything. We hope that what remains can be used as a source of inspiration for your own static site. |
| 13 | + |
| 14 | +If you find something that needs to be fixed, you can always [contact our terrific Support team](https://github.com/contact?form%5Bsubject%5D=Moving+developer.github.com+to+github-archive). |
| 15 | + |
| 16 | +Thank you! |
| 17 | + |
| 18 | +* * * |
| 19 | + |
| 20 | +This was the GitHub API documentation, built with [Nanoc][nanoc]. |
| 21 | + |
| 22 | +## Development |
| 23 | + |
| 24 | +You can fetch the latest dependencies by opening the command line and running `script/bootstrap`: |
| 25 | + |
| 26 | +``` sh |
| 27 | +$ script/bootstrap |
| 28 | +==> Installing gem dependencies… |
| 29 | +==> Installing npm dependencies… |
| 30 | +``` |
| 31 | + |
| 32 | +You'll need Ruby and Node installed on your system. The required versions for each of these languages can be found in the *.ruby-version* and *package.json* files, respectively. |
| 33 | + |
| 34 | +You can run `bundle exec rake build` to generate the site, but it's often more useful |
| 35 | +to simply build the server *and* start the site at the same time. |
| 36 | + |
| 37 | +Nanoc compiles the site into static files living in `output`. It's |
| 38 | +smart enough not to try to compile unchanged files. |
| 39 | + |
| 40 | +You can start the site with `script/server`: |
| 41 | + |
| 42 | +``` sh |
| 43 | +$ script/server |
| 44 | +Loading site data... |
| 45 | +Compiling site... |
| 46 | + create [0.28s] output/index.html |
| 47 | + create [1.31s] output/v3/gists/comments/index.html |
| 48 | + identical [1.92s] output/v3/gists/index.html |
| 49 | + identical [0.25s] output/v3/issues/comments/index.html |
| 50 | + update [0.99s] output/v3/issues/labels/index.html |
| 51 | + update [0.05s] output/v3/index.html |
| 52 | + … |
| 53 | + |
| 54 | +Site compiled in 5.81s. |
| 55 | +``` |
| 56 | + |
| 57 | +The site is hosted at `http://localhost:4000`. |
| 58 | + |
| 59 | +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. |
| 60 | + |
| 61 | +[nanoc]: http://nanoc.ws/ |
| 62 | + |
| 63 | +### Enterprise |
| 64 | + |
| 65 | +To generate the `/enterprise` versions, pass in the Enterprise version to `script/server`. For example: |
| 66 | + |
| 67 | +``` sh |
| 68 | +$ script/server 2.6 |
| 69 | +``` |
| 70 | + |
| 71 | +Note that live reloading is not available for Enterprise documentation. |
| 72 | + |
| 73 | +## Styleguide |
| 74 | + |
| 75 | +Not sure how to structure the docs? Here's what the structure of the |
| 76 | +API docs should look like: |
| 77 | + |
| 78 | + # API title |
| 79 | + |
| 80 | + {:toc} |
| 81 | + |
| 82 | + ## API endpoint title |
| 83 | + |
| 84 | + [VERB] /path/to/endpoint |
| 85 | + |
| 86 | + ### Parameters |
| 87 | + |
| 88 | + Name | Type | Description |
| 89 | + -----|------|-------------- |
| 90 | + `name`|`type` | Description. |
| 91 | + |
| 92 | + ### Input (request JSON body) |
| 93 | + |
| 94 | + Name | Type | Description |
| 95 | + -----|------|-------------- |
| 96 | + `name`|`type` | Description. |
| 97 | + |
| 98 | + ### Response |
| 99 | + |
| 100 | + <%= headers 200, :pagination => default_pagination_rels, 'X-Custom-Header' => "value" %> |
| 101 | + <%= json :resource_name %> |
| 102 | + |
| 103 | +**Note**: We're using [Kramdown Markdown extensions](http://kramdown.gettalong.org/syntax.html), such as definition lists. |
| 104 | + |
| 105 | +### JSON Responses |
| 106 | + |
| 107 | +We specify the JSON responses in Ruby so that we don't have to write |
| 108 | +them by hand all over the docs. You can render the JSON for a resource |
| 109 | +like this: |
| 110 | + |
| 111 | +```erb |
| 112 | +<%= json :issue %> |
| 113 | +``` |
| 114 | + |
| 115 | +This looks up `GitHub::Resources::ISSUE` in `lib/resources.rb`. |
| 116 | + |
| 117 | +Some actions return arrays. You can modify the JSON by passing a block: |
| 118 | + |
| 119 | +```erb |
| 120 | +<%= json(:issue) { |hash| [hash] } %> |
| 121 | +``` |
| 122 | + |
| 123 | +There is also a rake task for generating JSON files from the sample responses in the documentation: |
| 124 | + |
| 125 | +``` sh |
| 126 | +$ rake generate_json_from_responses |
| 127 | +``` |
| 128 | + |
| 129 | +The generated files will end up in *json-dump/*. |
| 130 | + |
| 131 | +### Terminal blocks |
| 132 | + |
| 133 | +You can specify terminal blocks by using the `command-line` syntax highlighting. |
| 134 | + |
| 135 | + ``` command-line |
| 136 | + $ curl foobar |
| 137 | + ``` |
| 138 | + |
| 139 | +You can use certain characters, like `$` and `#`, to emphasize different parts |
| 140 | +of commands. |
| 141 | + |
| 142 | + ``` command-line |
| 143 | + # call foobar |
| 144 | + $ curl <em>foobar<em> |
| 145 | + .... |
| 146 | + ``` |
| 147 | + |
| 148 | +For more information, see [the reference documentation](https://github.com/gjtorikian/extended-markdown-filter#command-line-highlighting). |
| 149 | + |
| 150 | +## Licenses |
| 151 | + |
| 152 | +The code to generate the site (everything excluding the assets, content, |
| 153 | +and layouts directories) as well as the code samples on the site are |
| 154 | +licensed under |
| 155 | +[CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode). |
| 156 | +CC0 waives all copyright restrictions but does not grant you any trademark |
| 157 | +permissions. |
| 158 | + |
| 159 | +Site content (everything in the assets, content, and layouts directories, |
| 160 | +excluding files under open source licenses individually marked) is licensed |
| 161 | +under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0 |
| 162 | +gives you permission to use content for almost any purpose but does not grant |
| 163 | +you any trademark permissions, so long as you note the license and give credit, |
| 164 | +such as follows: |
| 165 | + |
| 166 | +> Content based on |
| 167 | +> <a href="https://github.com/github/developer.github.com">developer.github.com</a> |
| 168 | +> used under the |
| 169 | +> <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a> |
| 170 | +> license.</a> |
| 171 | +
|
| 172 | +This means you can use the code and content in this repository except for |
| 173 | +GitHub trademarks in your own projects. |
| 174 | + |
| 175 | +When you contribute to this repository you are doing so under the above |
| 176 | +licenses. |
0 commit comments