OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity
33,357 Commits 30 Branches 683 Tags
e8b1ea4ee2a2c05ae4ac477fe4e6610a44b26b21
Commit Graph

88 Commits

Author SHA1 Message Date
Antoine du Hamel
e8b1ea4ee2 tools,doc: add "legacy" badge in the TOC 
PR-URL: https://github.com/nodejs/node/pull/37949
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2021-04-01 12:31:25 -07:00
Antoine du Hamel
1f80f6bffc doc: fix JS flavor selection 
PR-URL: https://github.com/nodejs/node/pull/37791
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
 2021-03-20 19:19:04 +01:00
James M Snell
d3417bbafb doc: apply style for legacy status 
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/37784
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
 2021-03-19 12:38:45 -07:00
Antoine du Hamel
2e1e74e9f8 tools,doc: add support for several flavors of JS code snippets 
Enable code example using both modern ESM syntax and legacy CJS syntax.
It adds a toggle on the web interface to let users switch from one
JavaScript flavor to the other.

PR-URL: https://github.com/nodejs/node/pull/37162
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
 2021-03-06 16:13:57 +01:00
Antoine du Hamel
0177d4cc20 doc: optimize HTML rendering 
Defer rendering sections of docs until they are displayed on
the user's screen.

PR-URL: https://github.com/nodejs/node/pull/37301
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2021-02-15 16:14:15 +01:00
Antoine du Hamel
b750f74b67 doc: fix color contrast on <kbd> elements 
PR-URL: https://github.com/nodejs/node/pull/37185
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2021-02-02 14:43:20 +01:00
Zijian Liu
2bb42bf156 tools,doc: list the stability status of each API 
Fixes: https://github.com/nodejs/node/issues/23723

PR-URL: https://github.com/nodejs/node/pull/36223
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2021-01-20 01:23:45 +01:00
Mattia Pontonio
2ba8728b9f doc: wrap TOC in a <details> tag 
PR-URL: https://github.com/nodejs/node/pull/36896
Fixes: https://github.com/nodejs/node/issues/36885
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
 2021-01-14 16:35:59 +01:00
Ajay Poshak
9ff555b7a2 doc: add dark mode 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/36313
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
 2021-01-07 14:22:07 +01:00
Rich Trott
ce84bacdc6 doc: improve kbd element rendering 
* better vertical alignment with text
* slightly larger "key" size
* remove top light area (from box-shadow)

PR-URL: https://github.com/nodejs/node/pull/35497
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-10-08 04:43:42 -07:00
Rich Trott
cd226c0305 doc: adopt MDN style for kbd elements 
PR-URL: https://github.com/nodejs/node/pull/35460
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-10-04 05:34:14 -07:00
Rich Trott
aa3746d0a6 doc: implement fancier rendering for keys 
Minimal CSS and markup changes to implement special rendering for
`<kbd>` elements.

PR-URL: https://github.com/nodejs/node/pull/35400
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
 2020-10-02 03:27:05 -07:00
Rich Trott
4fdc5ace6a doc: fix left nav color contrast 
I believe this is the last change to make in the docs for color contrast
accessibility per WCAG AA.

Currently, the current item in the nav is #43853d on a #333333
background for a color contrast of 2.8:1, failing WCAG AA. This swaps in
removes a confusing bottom border on the item, replacing it with
bolding to preserve the item's highlighting.

PR-URL: https://github.com/nodejs/node/pull/35141
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
 2020-09-12 09:49:23 -07:00
Rich Trott
661b770e11 doc: restore color for visited links 
A previous change altered the rendering of visited links. This restores
it.

PR-URL: https://github.com/nodejs/node/pull/35108
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
 2020-09-10 05:33:35 -04:00
Rich Trott
bb9117ee9f doc: change stablility-2 color for accessibility 
Current contrast ratio (2.51) does not pass WCAG AA. This PR increases
the contrast to 4.50, which passes WCAG AA. The color, of course, is
still green.

PR-URL: https://github.com/nodejs/node/pull/35061
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
 2020-09-06 16:50:18 -07:00
Antoine du HAMEL
ec5958f38e doc: remove style for empty links 
PR-URL: https://github.com/nodejs/node/pull/35034
Refs: https://github.com/nodejs/node/pull/34955
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
 2020-09-05 13:56:33 -07:00
Rich Trott
f3b4846527 doc: change color contrast for accessibility 
Change background color of Stability 1 banner. Previous color contrast
of 3.61:1 fails WCAG AA. New color contrast of 4.50:1 passes.

PR-URL: https://github.com/nodejs/node/pull/35047
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
 2020-09-04 15:52:43 -07:00
Justice Almanzar
6f0b87d6c9 doc: remove space above version picker 
PR-URL: https://github.com/nodejs/node/pull/34768
Fixes: https://github.com/nodejs/node/issues/34767
Fixes: https://github.com/nodejs/node/issues/34447
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-08-19 23:50:26 +02:00
Antoine du HAMEL
f280d2c85c doc: add padding in the sidebar column 
PR-URL: https://github.com/nodejs/node/pull/34665
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ricky Zhou <0x19951125@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Evan Lucas <evanlucas@me.com>
 2020-08-11 13:19:37 -07:00
Antoine du HAMEL
c093f6b4d1 doc: use semantically appropriate tag for lines 
The HTML <hr> element represents a thematic break between
paragraph-level elements: for example, a change of scene in a story,
or a shift of topic within a section.
The HTML Content Division element (<div>) is the generic container
for flow content and does not inherently represent anything.

The <hr> tag semantically fits better the meaning of the line between
the lists.

Refs: https://html.spec.whatwg.org/multipage/grouping-content.html#the-hr-element

PR-URL: https://github.com/nodejs/node/pull/34660
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-08-11 13:18:54 -07:00
Rodion Abdurakhimov
d853145277 doc: fix source link margin to sub-header mark 
Prior to this commit, [src] link overlapped sharped (#) sub-header link

PR-URL: https://github.com/nodejs/node/pull/33664
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-07-03 13:35:17 -07:00
Alhadis
f14229e704 doc: eliminate dead space in API section's sidebar 
This commit improves overall usability on desktop by removing the "dead"
(non-interactive) regions between links in the API section's navigation.
No visible changes have been made; this enhancement is purely tactile in
nature.

PR-URL: https://github.com/nodejs/node/pull/33469
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
 2020-05-23 17:37:47 +02:00
David Gilbertson
7baadb30bb doc: prevent tables from shrinking page 
Tables on some pages (e.g. https://nodejs.org/api/crypto.html) are
quite wide because of long content (e.g. URLs) that don't break.
With this change, cell padding is smaller on small screens, and the
table content is allowed to break.

PR-URL: https://github.com/nodejs/node/pull/31859
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-03-11 16:59:16 +01:00
XhmikosR
70c32a6d19 doc: remove redundant properties from headers 
PR-URL: https://github.com/nodejs/node/pull/31492
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
 2020-01-28 15:34:17 +00:00
Rich Trott
97ac661302 doc: enable visual code indication in headers 
This enables the grey background for inline code in headers.

Refs: https://github.com/nodejs/node/pull/31460#issuecomment-577154740

PR-URL: https://github.com/nodejs/node/pull/31493
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
 2020-01-26 08:08:17 -08:00
Rich Trott
d32a71542e doc: fix code display in header glitch 
Fixes: https://github.com/nodejs/node/issues/31451

PR-URL: https://github.com/nodejs/node/pull/31460
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
 2020-01-24 04:51:54 -08:00
Rich Trott
fdec6bd744 doc: allow <code> in header elements 
Allow use of <code> in header elements without styling side effects. We
can add styling later if desired. The goal here is to allow code to be
set off in markdown without needing to escape characters and do lint
exceptions for terms. This is probably a win in terms of accessibility
too although it would be moreso if we had some visual differentiation
for <code> inside of headers. As mentioned above, that can always be
added at a later time.

PR-URL: https://github.com/nodejs/node/pull/31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
 2019-12-26 21:31:52 -08:00
XhmikosR
cdf8f708cf doc: implement minor CSS improvements 
* 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-10-03 20:04:43 -07:00
Roman Reiss
6447be6203 doc: adjust TOC margins 
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>
 2019-06-07 11:22:16 +02:00
Thomas Hunter II
344a46ad03 doc: adjusting formatting when printing 
- 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-11-16 21:13:46 -08:00
Sam Ruby
60465700ed tools: Include links to source code in documentation 
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-08-29 22:20:46 -04:00
Rich Trott
61cd101e12 doc: add "Edit on GitHub" link 
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-07-13 20:37:05 -07:00
Roman Reiss
0baad8f0eb doc: better font stack for monospace in docs 
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-31 15:07:01 +02:00
Vse Mozhet Byt
8d3131b0af doc: fix nits in doc/api_assets/style.css 
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>
 2018-05-10 18:19:43 +03:00
silverwind
42479130a9 doc: fix paragraph line-height issue 
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-15 12:39:49 +02:00
silverwind
6d9654b13d doc: responsive docs, rewrite font sizes 
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-10-10 21:28:15 +02:00
Chris Young
2b7b9f24d9 doc: prevent displaying empty version picker 
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-09-19 16:10:19 -03:00
Chris Young
cacce304cb doc: add links to alternative versions of doc 
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-28 11:17:08 +02:00
Saad Quadri
eab2bea46f doc: fix word wrapping for api stability boxes 
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-08-16 11:49:55 +02:00
Gibson Fahnestock
7c8bbe37b7 doc: reduce font size on smaller screens 
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-09 10:59:24 +01:00
Anna Henningsen
7cbb4b0e6e tools,doc: enable changelogs for items 
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-02-24 02:06:31 +01:00
Roman Reiss
245a92894b doc: fix <code> inside stability boxes 
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-22 19:40:02 +01:00
Daniel Bevenius
bd83422a71 doc: fix minor style issue in code examples 
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-11-11 21:09:20 +01:00
Jeremiah Senkpiel
f1a3755cd1 doc: improve header styling for API docs 
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-21 22:01:40 +01:00
Ilya Frolov
fcee4d4ad9 doc: highlight deprecated API in ToC 
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-10-14 07:30:38 +02:00
Marian
c161849bfa doc: make the api doc print-friendly 
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-23 12:26:21 +02:00
Roman Reiss
bef1ec086d doc: fix issues related to page scrolling 
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-15 13:47:32 +02:00
Tristian Flanagan
015f4fda0e tools: parse documentation metadata 
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-05 01:15:10 +02:00
Claudio Rodriguez
7fdffb66d7 doc: remove all scrollbar styling 
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-05-01 16:23:57 +01:00
Jeremiah Senkpiel
0a3472613b doc: subdivide TOC, add auxiliary links 
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-29 13:27:18 -04:00