BackPup/node
1
0 Fork 0
mirror of https://github.com/nodejs/node.git synced 2026-11-09 15:11:11 -05:00
Code Issues Packages Projects Releases Wiki Activity
15,720 Commits 266 Branches 972 Tags
e432c2bfaab27c1917426257aa56269fe74bc893
Commit Graph
51 Commits
Author SHA1 Message Date
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
Luigi Pinca d2577def93 doc: fix scrolling on iOS devices 
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-04-09 18:21:05 +02:00
silverwind 7ae3dfb153 doc: update link green to match homepage 
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-03-03 19:41:47 +01:00
Roman Reiss 3add7a7b9c doc: improve scrolling, various CSS tweaks 
- 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-14 05:46:18 +01:00
Claudio Rodriguez 47e926a8d6 doc: fix type references for link gen, link css 
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-02-09 13:12:21 +01:00
Roman Reiss 55607a0f32 doc: style fixes for the TOC 
- 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-23 23:10:43 +01:00
Roman Reiss d157976cec doc: update stylesheet to match frontpage 
- 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>
 2016-01-11 09:49:56 -08:00
jpersson f4f1e89bf1 doc: fix color of linked code blocks 
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-30 18:56:36 +01:00
Roman Reiss 8b75030249 doc: fix rare case of misaligned columns 
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-11-27 01:52:33 +01:00
phijohns d995b72db9 doc: made code spans more visible in the API docs 
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-10-29 22:57:03 +01:00
Sakthipriyan Vairamani 31188b796e tools: fix anchors in generated documents 
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-08-23 00:15:18 +05:30
Roman Reiss 19641b17be doc: decouple sidebar scrolling 
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-03-28 12:31:23 +01:00
Chris Dickinson cf0306cd71 doc: update stability index 
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-27 14:23:01 -08:00
Jeremiah Senkpiel cb22bc9b8a doc: fix footer sizing 
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-22 19:36:24 -08:00
Omer Wazir 789ff959be doc: increase mark class contrast ratio 
PR-URL: https://github.com/iojs/io.js/pull/824
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
 2015-02-12 12:12:37 -08:00
Jeremiah Senkpiel 122a1758d1 doc: better font-smoothing for firefox 
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-12 12:11:36 -08:00
Roman Reiss 982b143ab3 doc: disable font ligatures 
PR-URL: https://github.com/iojs/io.js/pull/816
Reviewed-By:  Nicu Micleușanu <micnic90@gmail.com>
 2015-02-12 12:48:32 +02:00
Phil Hughes e7891034c2 doc: fix 404s for syntax highlighting js 
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-15 10:09:24 -08:00
Chris Dickinson 9120f2b1fd doc: update style for iojs 
* 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>
 2015-01-12 13:44:50 -08:00
isaacs 04e0324f6a doc: style the 'type' fields in API docs 2013-07-16 10:49:54 -07:00
isaacs db5776cf8b doc: Streams API Doc Rewrite 
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-07-16 10:49:54 -07:00
isaacs 0e21d7b985 doc: link joyent logo in website footer 2013-05-02 09:48:33 -07:00
Luke Arduini 192192a09e Colorize API stabilitity index headers in docs 
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-12-27 18:38:56 -08:00
Max Ogden 323bbdb0cb doc: set default background color to white 2012-10-13 00:54:21 +02:00
Bert Belder 45cd4e211e doc: use somewhat consistent styling for css assets 2012-08-23 17:54:12 +02:00
isaacs 5ca5ec33cc doc: css consistency on anchor links 2012-03-03 22:58:47 -08:00
isaacs ef5b0f4c8e css: Fix fonts on api index page navigation 2012-03-02 12:36:45 -08:00
isaacs 1a181315eb Increase contrast of links, decrease contrast of bullets 2012-02-29 15:20:06 -08:00
isaacs 63629614cb Update styles to reflect changed api doc html structure 2012-02-29 15:19:59 -08:00
isaacs 4051c2843b docs: Move images out of the dist tarball 
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
 2012-02-29 15:17:55 -08:00
isaacs 7b93eb0000 doc: Remove default border around logo for MSIE 2012-01-23 13:50:31 -08:00
isaacs 6768d2fc93 doc: Pixel-nudging 2012-01-23 13:11:33 -08:00
isaacs 4fd315192a Add images to doc_assets 2012-01-23 13:11:32 -08:00
Matthew Fitzsimmons 831c8199f6 Nodejs.org design refresh. 2012-01-23 13:11:32 -08:00
Vitor Balocco 97d355c273 docs: Add anchor links next to each function 
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.
 2011-09-21 21:08:53 +09:00
Ryan Dahl b6c66f735b Revert "Use html5 spec stylesheet for docs" 
This reverts commit 6dbf49110b.
 2011-01-27 19:55:52 -08:00
Ryan Dahl 6dbf49110b Use html5 spec stylesheet for docs 2011-01-11 14:32:42 -08:00
Micheil Smith 57de0b11db Remove jQuery from project 2010-11-17 17:57:58 -08:00
Micheil Smith 8d27393aa2 Generate Table of Contents at compile time. 2010-11-17 17:38:54 -08:00
Micheil Smith 939fba40fd Better doc indexes, fix some links 2010-11-15 19:59:21 -08:00
Micheil Smith 09e60aa435 A few changes to the style, specifically for h3 + h3 2010-11-14 13:52:34 -08:00
Micheil Smith 17595b5343 Various changes to Net Documentation, ammended style for API. 2010-11-14 13:52:31 -08:00