dan/api_docs
1
0
Fork 0
mirror of https://github.com/danbulant/api_docs synced 2026-05-19 04:08:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
565 commits 3 branches 15 tags 1.4 MiB
Commit graph

195 commits

Author SHA1 Message Date
Robert Lord
3c36233e6b Merge pull request #95 from samdozor/dev 
Changing the code font-family to prefer Menlo/Consolas over Monaco
 2014-07-17 09:37:42 -07:00
Sam Dozor
54e4408d8c Changing the code-font font-family to prefer Menlo and Consolas over Monaco, and adding more back-up fonts. 2014-07-16 16:53:38 -04:00
Robert Lord
60d1dbd37d Update search results to scroll, remove initial dummy text 2014-07-03 00:11:02 -07:00
Robert Lord
18cd104883 Add better search results in a sliding search results area 2014-07-02 23:43:25 -07:00
Robert Lord
51e537aca2 Simplify embossed tocify styles, in preperation for search 2014-07-02 23:38:17 -07:00
Robert Lord
1b1427c3ee Add placeholder to search box 2014-07-02 22:46:14 -07:00
Robert Lord
324da17ba3 Fix bugs with toc not highlighting, begin search overhaul 2014-07-02 22:34:58 -07:00
Robert Lord
e8a491c9ea Fix unrecognized .highlight. bug #84 2014-06-24 01:03:39 -07:00
Robert Lord
d1fdd685a6 Fix default language selection bug 2014-06-22 03:10:26 -07:00
Robert Lord
0f93ffcc2b More js cleanup for #80 2014-06-22 02:41:16 -07:00
Robert Lord
bdbd7a38a8 Update app javascript to pass jslint, fixes #80 2014-06-22 02:37:01 -07:00
Robert Lord
b147e6a2d7 Update toc javascript to hopefully be more performant 2014-06-22 02:33:55 -07:00
Robert Lord
f4f2a1abfa Re-rotate nav button image 2014-06-14 19:43:37 -07:00
Robert Lord
b5419b1e9c Add background to nav button 2014-06-14 19:41:08 -07:00
Robert Lord
3a91faa8e6 Fix bug with messed up margin on some code samples on phones 2014-06-14 19:19:48 -07:00
Robert Lord
65496915b8 Hide mobile lang selector and search on print 2014-06-12 16:02:41 -07:00
Robert Lord
3125ad8f72 Add extra margin to nav touch targets on mobile 2014-06-12 01:48:53 -07:00
Robert Lord
1e144aaa66 Update nav button to go to very edge of screen 2014-06-12 01:39:37 -07:00
Robert Lord
1478579c59 Add language tabs to navbar on phone 2014-06-12 01:32:25 -07:00
Robert Lord
d77f1e7b9f Increase size of nav button touch target area 2014-06-12 00:51:50 -07:00
Robert Lord
e559ad1097 Add first draft of single column design for phones 2014-06-12 00:32:50 -07:00
Robert Lord
c2c35cfa25 Add retracting sidebar for tablets 2014-06-12 00:01:52 -07:00
Robert Lord
ec9a688846 Fix bad h1 top border commit 2014-06-11 23:09:04 -07:00
Robert Lord
4d4f6efeb8 Fix #75, don't set page hash to undefined 2014-06-11 22:10:31 -07:00
Robert Lord
5a69760f54 Remove top border from first h1 of page 2014-06-11 22:04:08 -07:00
Robert Lord
0aff03f8da Fixes #77, update sites without search 
Sites without search now do not include search.js or lunr.js,
making the javascript for those pages much faster to load.
 2014-06-11 21:58:33 -07:00
Robert Lord
b363be873b Update language tabs to properly stay in section, and fix history navigation bug 2014-06-11 21:49:37 -07:00
Robert Lord
7dead4c392 Update selected tab to not darken on mousedown 2014-06-11 21:21:28 -07:00
Robert Lord
d71ae97f7a Remove excess whitespace, add extra equal sign to lang.js 2014-06-11 21:15:26 -07:00
bootstraponline
1e341563fb Fix language on load 2014-05-18 12:29:03 -04:00
Christopher Rogers
e0cee862d9 Fixes a variable leak and simplifies low score filtration 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-05-07 19:39:16 -07:00
Robert Lord
e5cf1f2589 Merge pull request #56 from bootstraponline/scroll_to_closest_header 
Scroll to closest header
 2014-05-05 12:16:45 -04:00
Robert Lord
6bf197da74 Merge pull request #53 from bootstraponline/dont_crash_on_invalid_language 
Don't crash on invalid language
 2014-05-05 11:51:40 -04:00
bootstraponline
2f617a2160 Scroll to closest header 2014-04-27 21:50:33 -04:00
bootstraponline
f9c4195f23 Don't crash on invalid language 2014-04-27 16:32:11 -04:00
bootstraponline
2384d9af3f Reposition headers based on score 
Enforce min score
 2014-04-26 10:23:57 -04:00
Robert Lord
84b3e5e3d6 Add search frontmatter key to specify visibility of search 2014-04-21 12:18:44 -04:00
Robert Lord
0316c0c5e9 Add aside print styling, fixes #4 2014-04-21 12:10:36 -04:00
Robert Lord
259bf0f560 Remove from screen.scss that was causing errors 2014-04-21 12:05:07 -04:00
Robert Lord
6d73ffb052 Remove leftover console.logs from tocify edits 2014-04-21 11:56:00 -04:00
Robert Lord
75869a561f Prevent reload page on language change, fixes #36 
- Uses onpopstate to handle users pressing back buttons
- Switches the query string and changes the language
  without reloading.
- Thanks to @bootstraponline for some of the code in this commit.
 2014-04-21 11:31:32 -04:00
bootstraponline
03b28598cc Fix flash as suggested by @lord 2014-04-19 22:01:56 -04:00
Robert Lord
0feb513407 Adjust search info appearance, fix Firefox bug 2014-04-19 21:36:00 -04:00
Robert Lord
7386fd2e21 Fix bug with section padding and long code blocks 2014-04-19 18:04:23 -04:00
Robert Lord
fc0c995cb6 Add h4,h5,h6 as suggested by @bootstraponline, fix section padding 2014-04-19 17:58:42 -04:00
Christopher Rogers
a4e1fb3c24 Adds js handler for setting search info box width equal to content width 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-16 15:05:05 -07:00
Christopher Rogers
0ebbae94fe Cleans up some css 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-16 14:11:43 -07:00
Christopher Rogers
440c799c4c Removes lunr stemmer from search index pipeline 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-16 14:03:58 -07:00
Christopher Rogers
3c4e0d0bae Switches jQuery to load through Google CDN 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-15 13:44:56 -05:00
Christopher Rogers
0a0e84b8e8 Standardizes search styles 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-15 13:40:45 -05:00
Christopher Rogers
4d568401a3 Improves no results notice and removes highlight and notice on search field blur 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-11 20:36:03 -07:00
Christopher Rogers
535a3b0486 Adds 'no results found' message to search 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-11 18:01:55 -07:00
Christopher Rogers
5892700b5c Fixes toc alignment on search and adds highlight library 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-11 10:27:15 -07:00
Christopher Rogers
59ee05c606 Updates search field markup and style 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-10 17:47:01 -07:00
Christopher Rogers
f2d1387971 Adds search icon 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-10 17:46:39 -07:00
Christopher Rogers
e669a0d4ac Adds rudimentary search support 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-09 18:12:55 -07:00
Christopher Rogers
d1b98be182 Cleans up layout 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-09 18:12:05 -07:00
Christopher Rogers
b171d3c48a Organizes javascript into libraries and application code 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-09 14:54:23 -07:00
Christopher Rogers
adf94ffbf6 Simplifies layout language selection and js init logic 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-09 14:45:41 -07:00
Christopher Rogers
68807cd485 Fixes some leakage in the language selector 
Signed-off-by: Christopher Rogers <chrissrogers@gmail.com>
 2014-04-09 14:14:24 -07:00
Robert Lord
e307f1dbbb Update jQuery to work over SSL, resolves #18 2014-03-30 22:46:48 -04:00
Robert Lord
88fcba6798 Add explanation of partials to _errors.md 2014-03-30 22:42:54 -04:00
Marcio Lima
b90436e48e Add ability to split content in include files. 2014-03-28 12:29:31 -03:00
Robert Lord
35598a4e16 Add styling for horizontal rules 2013-12-31 16:34:19 -08:00
Robert Lord
d744b8a22f Add styling for definition lists 2013-12-20 10:44:14 -08:00
Robert Lord
198484ef2b Add hack to prevent tocify from animating on page load 2013-10-31 13:44:02 -07:00
Robert Lord
d3ab3cc4b7 Add asides for nice-looking notes and warnings 
You can now use <aside> with the classes

- warning
- success
- notice

to add little colored notes to your API docs! Examples are in
source/index.md.

Also, note that if you have a custom variables.scss, you'll have
to add

+$aside-notice-bg: #8fbcd4;
+$aside-warning-bg: #c97a7e;
+$aside-success-bg: #6ac174;

to it.
 2013-10-31 12:26:07 -07:00
Robert Lord
bdd05b3c0c Fix bug where weird white block could appear at bottom of page. 
This bug occured if the final code sample extended beyond the
explanation at the bottom of the page.

To fix it, I simply made the background color of body a soft
blue.
 2013-10-31 10:56:54 -07:00
Robert Lord
c404bc02df Add default language selecting with localStorage 
Now, Slate will use localStorage to track the last selected
language, so if the user visits again with no language in the URL,
they will be redirected to the last language they used.

This update also fixes a bug with how the layout inserts the
language names into the javascript. Previously, they would be,
(for some inane reason) arrays within arrays. It is now just
an array. Whoever wrote that previous code was clearly a fool.
 2013-10-29 10:40:07 -07:00
Robert Lord
e2b70aff42 Change print stylesheet, fix slight bug with naming 
Also changed README wording slightly.
 2013-10-25 11:39:53 -07:00
Robert Lord
834119ecd8 Add print stylesheet 2013-10-25 11:33:19 -07:00
Robert Lord
26d47b06a0 Fix bug where syntax.css would fail to compile, causing errors 2013-10-21 15:17:35 -07:00
Robert Lord
dc33dfe0a7 Add table of contents footer links feature 
Now you can add links to the bottom of your table of contents!
Documentation has also been changed to reflect this new
feature.

Please note that if you have a custom variables.scss, you'll have
to merge in this line:

    $nav-footer-border-color: #666;
 2013-10-21 14:09:38 -07:00
Robert Lord
6a22d7c11d Update SCSS, fix bug where code annotations had wrong font. 2013-10-16 12:45:00 -07:00
Robert Lord
04c0abbcfa Refactor SCSS for better organization, readability, and customizability. 2013-10-11 15:55:46 -07:00
Robert Lord
e5658f498a Update copyright year 2013-10-11 11:55:42 -07:00
Robert Lord
91ff8a738a Add copyright information to source files 2013-10-11 11:28:04 -07:00
Robert Lord
489fb16b94 Update README.md and default index.md 
Seriously upgraded the README documentation.
ALso, added a tiny fix to the Kittn example in index.md.
 2013-10-09 15:18:14 -07:00
Robert Lord
8aa611f77a Adjust styling of border below h1 tag to be more consistent 2013-10-07 12:30:32 -07:00
Robert Lord
84b7705fd1 Add Kittn example file 2013-10-07 12:29:37 -07:00
Robert Lord
b15573155e Added sample code to index.md 2013-10-03 18:02:49 -07:00
Robert Lord
e641bd7d4a Add generic logo, remove TripIt logos. 2013-10-03 18:02:18 -07:00
Robert Lord
1030376e37 More style fixes and changes 2013-10-01 13:32:30 -07:00
Robert Lord
f7e6117e85 Various style updates and bugfixes 2013-09-27 13:42:57 -07:00
Robert Lord
38ad55851a Change language declaration 
Now, if no languages are specified, the language selection bar simply doesn't appear.

It has also been renamed from "languages" to "language_tabs".

Additionally, now language names default to the markdown name. They can still be overridden by the languagename:Display Name syntax.
 2013-09-27 13:37:36 -07:00
Robert Lord
7ae21ae972 Fix padding bug with blockquotes in the right area. 2013-09-25 10:15:59 -07:00
Robert Lord
fd80b240bd Make every other table row have a different color 2013-09-24 14:54:42 -07:00
Robert Lord
28f442e529 Add automatic hash generation with redcarpet dev, and change tocify scrollHistory to be compatible with the ids 2013-09-24 12:25:12 -07:00
Robert Lord
7ba798c51d Overflow fixes and toc horizontal scrollbar fix 2013-09-24 10:35:33 -07:00
Robert Lord
5cc9188e3c Fix tocify to reset cache on browser window resize 2013-09-24 09:47:40 -07:00
Robert Lord
9e84ebf28c Add margin to bottom of tables 2013-09-24 09:39:19 -07:00
Robert Lord
541998da39 Change code buttons to refresh the page with the language name after the ? in the url 
This commit has two benefits:

- Now, copying the URL will actually copy the current language as well. You don't need to think to add a language

- If a language moves objects on the page down, the tocify header location cache will not be invalid, since it is generated on page load. Therefore, if code moves some elements down, since the page is reloaded, the cache will also be regenerated, to reflect the real locations of the headers.
 2013-09-23 12:06:39 -07:00
Robert Lord
bc79a655e5 More changes 2013-09-23 10:38:13 -07:00
Robert Lord
6c077ba873 Add stylesheets, javascript, and html for documentation generation 2013-09-17 15:44:08 -07:00
Robert Lord
a1e673e599 Initial commit, with default middleman code 2013-09-13 15:24:31 -07:00