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
Micheil Smith
c032350f64
Adding build tools & templates/assets
2010-10-28 14:59:15 -07:00