summaryrefslogtreecommitdiff
path: root/doc/api_assets
Commit message (Collapse)AuthorAgeFilesLines
* doc: make the api doc print-friendlyMarian2016-05-231-0/+13
| | | | | | | | | | Fixes: https://github.com/nodejs/node/issues/6743 PR-URL: https://github.com/nodejs/node/pull/6748 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
* doc: fix issues related to page scrollingRoman Reiss2016-05-151-9/+1
| | | | | | | | | | | | Moved the sidebar to a fixed position and moved the main column to the page's body, which results in back/forward navigation through hash links and search highlight working again. Fixes: https://github.com/nodejs/node/issues/6637 Fixes: https://github.com/nodejs/node/issues/6751 Based on: https://github.com/nodejs/node/pull/5716 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com>
* tools: parse documentation metadataTristian Flanagan2016-05-051-0/+13
| | | | | | | | | | | | | | | | This commit introduces the Documentation YAML metadata concept to the documentation. - Parses added or Added for HTML - Parses all data for JSON Ref: https://github.com/nodejs/node/pull/3867 Ref: https://github.com/nodejs/node/issues/3713 Ref: https://github.com/nodejs/node/issues/6470 PR-URL: https://github.com/nodejs/node/pull/6495 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: remove all scrollbar stylingClaudio Rodriguez2016-05-011-29/+0
| | | | | | | | | | Returns the doc custom scrollbar to native style. Fixes: https://github.com/nodejs/node/issues/6443 PR-URL: https://github.com/nodejs/node/pull/6479 Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
* doc: subdivide TOC, add auxiliary linksJeremiah Senkpiel2016-04-291-1/+30
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/6167 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
* doc: fix scrolling on iOS devicesLuigi Pinca2016-04-091-22/+6
| | | | | | | | | | | | Fixes an issue that prevented scrolling from going past large code blocks on iOS devices. Also fixes a few minor styling issues that came up in the discussion. Fixes: https://github.com/nodejs/node/issues/5861 PR-URL: https://github.com/nodejs/node/pull/5878 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
* doc: update link green to match homepagesilverwind2016-03-031-6/+7
| | | | | | | Also fixed a minor color issue with :focus on the title. PR-URL: https://github.com/nodejs/node/pull/5548 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
* doc: improve scrolling, various CSS tweaksRoman Reiss2016-02-141-132/+116
| | | | | | | | | | | | | | | | | | | | | | | | | - Made scrolling of the sidebar not affect the main page by using a combination of overflow:hidden and overflow:scroll. - Changed the scrollbar of the sidebar to be visible again for accessibilty reasons and removed the indication gradient because it was causing too much issues. - In WebKit-based browsers, the scrollbar received custom styling making it appear to be outside of the sidebar. - The main content is no longer limited to 702px width, but now uses all available space. - Changed the background of the code blocks to a very similar, but neutral color and made inline blocks the same color. - Made inline code blocks inside italic sections not italic. - Simplified styling of api_stability classes by introducing a common class name for the stability levels. - Fixed various issues related to the green hover background on links. - Fixed code box overflow outside the main content area. - Various minor tweaks to paddings and margins. - Cleaned up numbers in the stylesheet, removing unnecessary units, decimals and empty selectors. PR-URL: https://github.com/nodejs/node/pull/5198 Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: fix type references for link gen, link cssClaudio Rodriguez2016-02-091-2/+6
| | | | | | | | | | | | | | | Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: https://github.com/nodejs/node/pull/4741 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: style fixes for the TOCRoman Reiss2016-01-231-2/+11
| | | | | | | | | | | | | | | - Hide the scrollbar on the TOC on all browsers. It was never the intention for it to be visible with the scroll indication in place. A wrapper element with 20px padding was added to accommodate for hopefully all scrollbar widths as well as to avoid overflowing content. - Fixed the scroll indication gradient on Safari, which was caused by the wrong from-color, which now matches the to-color. - Fixed a issue in old IE where the TOC didn't render on the correct position through setting `left: 0` and `top: 0` on it. PR-URL: https://github.com/nodejs/node/pull/4748 Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: update stylesheet to match frontpageRoman Reiss2016-01-111-30/+38
| | | | | | | | | | | | | | | | - Changed colors to match frontpage as close as possible. - Links are slightly more horizontally padded as compared before to accomodate for the hover effect. - Slightly reduced the scroll indication height on the TOC. - The main content is now offset using margin instead of the previous border hack. - remove empty footer that was rendering a dark bar on the bottom of each page without any content. PR-URL: https://github.com/nodejs/node/pull/4621 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
* doc: fix color of linked code blocksjpersson2015-11-301-0/+4
| | | | | | | | Links nested in backticks were not visually distinguishable before, this fixes them. PR-URL: https://github.com/nodejs/node/pull/4068 Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: fix rare case of misaligned columnsRoman Reiss2015-11-271-1/+1
| | | | | | | | | | | By using the same unit for the offset of the main column as used for the left column width, we ensure that browsers render the columns conistently. Ref: https://github.com/nodejs/help/issues/32 PR-URL: https://github.com/nodejs/node/pull/3948 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: made code spans more visible in the API docsphijohns2015-10-291-0/+2
| | | | | | | | | | This makes the code spans in the API docs more visible and therefore readable by adding some background color. PR-URL: https://github.com/nodejs/node/pull/3573 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* tools: fix anchors in generated documentsSakthipriyan Vairamani2015-08-231-0/+9
| | | | | | | | | When an anchor tag is used within a pre tag, the link is not distinguishable. This patch makes sure that the links are highlighted by underlining them. PR-URL: https://github.com/nodejs/node/pull/2491 Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: decouple sidebar scrollingRoman Reiss2015-03-281-2/+15
| | | | | | | | | | This lets the doc sidebar have its own scrolling container, making the page easier to navigate in cases where previously the menu was scrolled far off. PR-URL: https://github.com/iojs/io.js/pull/1274 Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
* doc: update stability indexChris Dickinson2015-02-271-9/+1
| | | | | | | | | | | | | | | | | | | This simplifies the stability index to 4 levels: 0 - deprecated 1 - experimental / feature-flagged 2 - stable 3 - locked Domains has been downgraded to deprecated, assert has been downgraded to stable. Timers and Module remain locked. All other APIs are now stable. PR-URL: https://github.com/iojs/io.js/pull/943 Fixes: https://github.com/iojs/io.js/issues/930 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com>
* doc: fix footer sizingJeremiah Senkpiel2015-02-221-1/+1
| | | | | | | | reduced to the minimal amount, any less shows a white bar. Semver: patch PR-URL: https://github.com/iojs/io.js/pull/860 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: increase mark class contrast ratioOmer Wazir2015-02-121-2/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/824 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: better font-smoothing for firefoxJeremiah Senkpiel2015-02-121-1/+1
| | | | | | | does the same thing for firefox as 'antialiased' does for webkit. PR-URL: https://github.com/iojs/io.js/pull/820 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: disable font ligaturesRoman Reiss2015-02-121-0/+2
| | | | | PR-URL: https://github.com/iojs/io.js/pull/816 Reviewed-By: Nicu Micleușanu <micnic90@gmail.com>
* doc: fix 404s for syntax highlighting jsPhil Hughes2015-01-152-0/+554
| | | | | | | | | Updated Makefile to remove special casing for those files, and moved the files to doc/api_assets. Fixes: https://github.com/iojs/iojs.github.io/issues/51 PR-URL: https://github.com/iojs/io.js/pull/409 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: update style for iojsChris Dickinson2015-01-122-298/+196
| | | | | | | | | | | | * updates the styling for the iojs docs * pulls the processing step for markdown files into a separate module * adds the ability to insert comments into the markdown PR-URL: https://github.com/iojs/io.js/pull/297 Fixes: https://github.com/iojs/iojs.github.io/issues/23 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: style the 'type' fields in API docsisaacs2013-07-161-1/+1
|
* doc: Streams API Doc Rewriteisaacs2013-07-161-0/+17
| | | | | | | | | | | | | The Streams API doc is now broken up into 3 sections: 1. API for Consumers 2. API for Implementors 3. Details and Extras This addresses one of the biggest points of confusion for new users who start to consume streams, and get the impression that they have to do lots of extra work and implement classes and such, just to get some data out of a file.
* doc: link joyent logo in website footerisaacs2013-05-021-0/+10
|
* Colorize API stabilitity index headers in docsLuke Arduini2012-12-271-0/+24
| | | | | | | | | Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
* doc: set default background color to whiteMax Ogden2012-10-131-0/+1
|
* doc: use somewhat consistent styling for css assetsBert Belder2012-08-232-197/+222
|
* doc: css consistency on anchor linksisaacs2012-03-031-5/+6
|
* css: Fix fonts on api index page navigationisaacs2012-03-021-2/+5
|
* Increase contrast of links, decrease contrast of bulletsisaacs2012-02-291-5/+6
|
* Update styles to reflect changed api doc html structureisaacs2012-02-291-17/+17
|
* docs: Move images out of the dist tarballisaacs2012-02-299-569/+15
| | | | | | | | | | | | This puts all images in doc/images/ and references them via http://nodejs.org/images/. Any complaints about copyright usage etc. can thus be node/joyent's problem, rather than the problem of a downstream distribution channel. Conflicts: Makefile
* doc: Remove default border around logo for MSIEisaacs2012-01-231-0/+1
|
* doc: Pixel-nudgingisaacs2012-01-231-95/+148
|
* Add images to doc_assetsisaacs2012-01-236-0/+0
|
* Nodejs.org design refresh.Matthew Fitzsimmons2012-01-231-26/+216
|
* docs: Add anchor links next to each functionVitor Balocco2011-09-211-1/+10
| | | | | | | | Modify doctool.js to automatically create anchor links for every function, for easy linking. Include support for functions that have a <h4> level Fixes: #1718.
* Revert "Use html5 spec stylesheet for docs"Ryan Dahl2011-01-272-217/+235
| | | | This reverts commit 6dbf49110b518b9c8d5d2673a6bd40de501c388e.
* Use html5 spec stylesheet for docsRyan Dahl2011-01-112-235/+217
|
* Remove jQuery from projectMicheil Smith2010-11-172-167/+0
|
* Generate Table of Contents at compile time.Micheil Smith2010-11-171-60/+10
|
* Better doc indexes, fix some linksMicheil Smith2010-11-152-7/+93
|
* A few changes to the style, specifically for h3 + h3Micheil Smith2010-11-141-2/+6
|
* Various changes to Net Documentation, ammended style for API.Micheil Smith2010-11-141-0/+4
|
* Adding build tools & templates/assetsMicheil Smith2010-10-286-0/+935
View Lorry Controller Status