summaryrefslogtreecommitdiff
path: root/doc/api_assets
AgeCommit message (Collapse)Author
2019-10-03doc: implement minor CSS improvementsXhmikosR
* split selectors to one per line * remove units from 0 * use double colon pseudo selectors consistently * use `background-color` instead of the `background` shorthand since only the color is supposed to change * remove leading zeros from numbers * remove redundant values from shorthands * use lowercase hex for colors * use numeric values for `font-weight` PR-URL: https://github.com/nodejs/node/pull/29669 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2019-06-07doc: adjust TOC marginsRoman Reiss
PR-URL: https://github.com/nodejs/node/pull/28075 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
2018-11-16doc: adjusting formatting when printingThomas Hunter II
- reduces page margins - removes emphasis from links - hides expandable history items - removes horizontal scrollbar from bottom of print output - reduce stability rectangle sizes - shrink headlines slightly - hide ToC (as it's unclickable when printed) Ref: https://thomashunter.name/nodejs-documentation-pdf PR-URL: https://github.com/nodejs/node/pull/24325 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Bryan English <bryan@bryanenglish.com>
2018-09-02doc: Remove 'dnt_helper.js'MaleDong
This file is totally useless, because it's an inner-used helper that is for publishment of doc files. PR-URL: https://github.com/nodejs/node/pull/22595 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-08-29tools: Include links to source code in documentationSam Ruby
Parse source code using acorn; extracting exports. When producing documentation, match exports to headers. When a match is found, add a [src] link. This first commit handles simple exported classes and functions, and does so without requiring any changes to the source code or markdown. Subsequent commits will attempt to match more headers, and some of these changes are likely to require changes to the source code and/or markdown. PR-URL: https://github.com/nodejs/node/pull/22405 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-07-13doc: add "Edit on GitHub" linkRich Trott
Proof of concept for an "Edit on GitHub" link, inspired by the Serverless docs. One issue is that the link is to the version of the docs on the master branch even if the person was reading a different version of the doc. I don't consider that a big problem, although we can always remove the link if it turns out to be a big problem. I don't think there is a good solution. PRs need to be opened against the master branch generally. Having a bunch of PRs against staging branches is probably not what we want. If there's an update to one version of the doc, there will usually be an update to other versions. PR-URL: https://github.com/nodejs/node/pull/21703 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2018-05-31doc: better font stack for monospace in docsRoman Reiss
There appear to be rendering issues with inconsistent glyph width when using the Monaco font on non-macOS machines. This change updates the native CSS font stack to use the same font stack as Boostrap does, minus the Monaco font. PR-URL: https://github.com/nodejs/node/pull/21036 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yazhong Liu <yorkiefixer@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-05-10doc: fix nits in doc/api_assets/style.cssVse Mozhet Byt
1. Merge rule sets for identical selectors. 2. Delete impossible selector block: we have only stability indexes 0, 1, and 2, so there can't be `.api_stability_3` class. Refs: nodejs.org/api/documentation.html#documentation_stability_index PR-URL: https://github.com/nodejs/node/pull/20601 Refs: https://nodejs.org/api/documentation.html#documentation_stability_index Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2017-10-15doc: fix paragraph line-height issuesilverwind
Fix a line-height issue introduced in #15660 where paragraphs containing <code> blocks would have unequal line heights. Fixes: https://github.com/nodejs/nodejs.org/issues/1399 PR-URL: https://github.com/nodejs/node/pull/16200 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2017-10-10doc: responsive docs, rewrite font sizessilverwind
This makes the docs much more mobile-friendly by adding a viewport meta tag which makes mobile browers properly scale fonts. Additionally the font sizes have been cleaned up to use `rem` units where possible. Also included are some fixes for the version dropdown. PR-URL: https://github.com/nodejs/node/pull/15660 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2017-09-19doc: prevent displaying empty version pickerChris Young
PR-URL: https://github.com/nodejs/node/pull/15420 Fixes: https://github.com/nodejs/node/issues/15396 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-08-28doc: add links to alternative versions of docChris Young
Each page of the API documentation should have links to other versions of the same page. This will make it easier to switch between the current "live" release at nodejs.org and LTS versions. PR-URL: https://github.com/nodejs/node/pull/10958 Fixes: https://github.com/nodejs/node/issues/10726 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-08-16doc: fix word wrapping for api stability boxesSaad Quadri
PR-URL: https://github.com/nodejs/node/pull/14809 Fixes: https://github.com/nodejs/nodejs.org/issues/1337 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2017-03-09doc: reduce font size on smaller screensGibson Fahnestock
The font size for tablet sized screens (or half a laptop screen) is overly large, reduce it to a more readable size. Fixes: https://github.com/nodejs/nodejs.org/issues/919 PR-URL: https://github.com/nodejs/node/pull/11695 Fixes: https://github.com/nodejs/nodejs.org#919 Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2017-03-03benchmark,build,doc,lib,src,test: correct typosBenjamin Fleischer
PR-URL: https://github.com/nodejs/node/pull/11189 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2017-02-24tools,doc: enable changelogs for itemsAnna Henningsen
PR-URL: https://github.com/nodejs/node/pull/11489 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com>
2017-01-25tools,doc: add Google Analytics tracking.Phillip Johnsen
Adds Google Analytics tracking script to all doc pages when `DOCS_ANALYTICS` is set when running `make`: ```bash $ DOCS_ANALYTICS=<GOOGLE ANALYTICS ID> make ``` By default (when `DOCS_ANALYTICS` is not set), no tracking scripts are included. It respects "Do Not Track" settings end users might have in their browser. Also changes make target `doc-upload` from depending on the `$(TARBALL)` target, to only depend on `doc` directly. PR-URL: https://github.com/nodejs/node/pull/6601 Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2016-11-22doc: fix <code> inside stability boxesRoman Reiss
Fixes: https://github.com/nodejs/node/issues/9714 PR-URL: https://github.com/nodejs/node/pull/9723 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-11-11doc: fix minor style issue in code examplesDaniel Bevenius
I've noticed that a few of the code examples have an minor indentation issue with the first line, for example: https://nodejs.org/api/child_process.html#child_process_child_process This commit attempt to fix this issue by using the solution provided provided by silverwind and hiendv. Fixes: https://github.com/nodejs/node/issues/9381 PR-URL: https://github.com/nodejs/node/pull/9482 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-10-21doc: improve header styling for API docsJeremiah Senkpiel
Sizes were mostly decided by using http://type-scale.com/ with the 1.250 "Major Third" scaling. PR-URL: https://github.com/nodejs/node/pull/8811 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Prince John Wesley <princejohnwesley@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Phillip Johnsen <johphi@gmail.com>
2016-10-14doc: highlight deprecated API in ToCIlya Frolov
Highlight deprecated API methods/properties in "Table of Contents" for increasing understandability. Adapted code to eslint standards. PR-URL: https://github.com/nodejs/node/pull/7189 Fixes: https://github.com/nodejs/nodejs.org/issues/772 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2016-05-23doc: make the api doc print-friendlyMarian
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>
2016-05-15doc: fix issues related to page scrollingRoman Reiss
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>
2016-05-05tools: parse documentation metadataTristian Flanagan
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>
2016-05-01doc: remove all scrollbar stylingClaudio Rodriguez
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>
2016-04-29doc: subdivide TOC, add auxiliary linksJeremiah Senkpiel
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>
2016-04-09doc: fix scrolling on iOS devicesLuigi Pinca
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>
2016-03-03doc: update link green to match homepagesilverwind
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>
2016-02-14doc: improve scrolling, various CSS tweaksRoman Reiss
- 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>
2016-02-09doc: fix type references for link gen, link cssClaudio Rodriguez
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>
2016-01-23doc: style fixes for the TOCRoman Reiss
- 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>
2016-01-11doc: update stylesheet to match frontpageRoman Reiss
- 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>
2015-11-30doc: fix color of linked code blocksjpersson
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>
2015-11-27doc: fix rare case of misaligned columnsRoman Reiss
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>
2015-10-29doc: made code spans more visible in the API docsphijohns
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>
2015-08-23tools: fix anchors in generated documentsSakthipriyan Vairamani
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>
2015-03-28doc: decouple sidebar scrollingRoman Reiss
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>
2015-02-27doc: update stability indexChris Dickinson
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>
2015-02-22doc: fix footer sizingJeremiah Senkpiel
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>
2015-02-12doc: increase mark class contrast ratioOmer Wazir
PR-URL: https://github.com/iojs/io.js/pull/824 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-02-12doc: better font-smoothing for firefoxJeremiah Senkpiel
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>
2015-02-12doc: disable font ligaturesRoman Reiss
PR-URL: https://github.com/iojs/io.js/pull/816 Reviewed-By: Nicu Micleușanu <micnic90@gmail.com>
2015-01-15doc: fix 404s for syntax highlighting jsPhil Hughes
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>
2015-01-12doc: update style for iojsChris Dickinson
* 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>
2013-07-16doc: style the 'type' fields in API docsisaacs
2013-07-16doc: Streams API Doc Rewriteisaacs
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.
2013-05-02doc: link joyent logo in website footerisaacs
2012-12-27Colorize API stabilitity index headers in docsLuke Arduini
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.
2012-10-13doc: set default background color to whiteMax Ogden
2012-08-23doc: use somewhat consistent styling for css assetsBert Belder
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-26 10:39:37 +0000