Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
5ba3b540d4
node/doc/template.html

94 lines
3.7 KiB
HTML
Raw Normal View History

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>
2020-11-22 10:54:56 +00:00
<!DOCTYPE html>
docs: use "Level 1" HTML5 features Since we're using an HTML doctype we might as well use "Level 1" HTML5 features. See more: http://mathiasbynens.be/notes/html5-levels#level-1 Fixes #2386.
2011-12-20 04:57:45 +00:00
<html lang="en">
Adding build tools & templates/assets
2010-10-28 12:18:54 +00:00
<head>
docs: use "Level 1" HTML5 features Since we're using an HTML doctype we might as well use "Level 1" HTML5 features. See more: http://mathiasbynens.be/notes/html5-levels#level-1 Fixes #2386.
2011-12-20 04:57:45 +00:00
<meta charset="utf-8">
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-09-28 20:27:29 +00:00
<meta name="viewport" content="width=device-width">
doc,tools: syntax highlight api docs at compile-time Prior to this commit, API docs would be highlighted after the page loaded using `highlightjs`. This commit still uses `highlightjs`, but runs the generation during the compilation of the documentation, making it so no script needs to load on the client. This results in a faster load, as well as allowing the pages to fully functional even when JavaScript is turned off. PR-URL: https://github.com/nodejs/node/pull/34148 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-06-30 19:35:28 +00:00
<meta name="nodejs.org:node-version" content="__VERSION__">
doctool: improve the title of pages in doc PR-URL: https://github.com/nodejs/node/pull/7939 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-08-01 17:31:28 +00:00
<title>__SECTION__ | Node.js __VERSION__ Documentation</title>
doc: specify `display=fallback` for Google Fonts PR-URL: https://github.com/nodejs/node/pull/29688 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2019-09-24 07:02:52 +00:00
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
Website js/css tweaks Remove jquery Use HTML5 doctype Simpler clearfix implementation Close download dialog with <Esc> key
2011-12-12 22:19:14 +00:00
<link rel="stylesheet" href="assets/style.css">
doc,tools: properly syntax highlight API ref docs Prior to this commit, all <pre> tags were being highlighted as JavaScript. This has been corrected to syntax highlight all languages appearing in the API reference docs. This was accomplished by using highlight.js instead of SHJS for the frontend lib. * remove SHJS JavaScript code * add highlight.js bundle * fix script tags to reflect replacement * migrate CSS to use highlight.js classes * add appropriate documentation * ensure api_assets README.md stays interal Fixes: https://github.com/nodejs/node/issues/33363 PR-URL: https://github.com/nodejs/node/pull/33442 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
2020-05-16 19:54:24 +00:00
<link rel="stylesheet" href="assets/hljs.css">
node: rename from io.js to node This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
2015-08-13 16:14:34 +00:00
<link rel="canonical" href="https://nodejs.org/api/__FILENAME__.html">
doc: make header smaller and dropdown click-driven when JS is on PR-URL: https://github.com/nodejs/node/pull/42165 Fixes: https://github.com/nodejs/node/issues/42286 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-03-22 21:31:56 +00:00
<script async defer src="assets/api.js" type="text/javascript"></script>
doc: remove flicker on page load on dark theme Theme applying logic get loaded and executed in async mode, so often there is a delay in applying the proper theme to a page which leads to flicker on dark theme. Resolved by moving critical logic to the page head PR-URL: https://github.com/nodejs/node/pull/50942 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Claudio Wunder <cwunder@gnome.org>
2023-11-27 15:57:21 +00:00
<script>
const storedTheme = localStorage.getItem('theme');
// Follow operating system theme preference
if (storedTheme === null && window.matchMedia) {
const mq = window.matchMedia('(prefers-color-scheme: dark)');
if (mq.matches) {
document.documentElement.classList.add('dark-mode');
}
} else if (storedTheme === 'dark') {
document.documentElement.classList.add('dark-mode');
}
</script>
tools: fix CJS/ESM toggle on small screens PR-URL: https://github.com/nodejs/node/pull/43506 Co-authored-by: Moshe Atlow <moshe@atlow.co.il> Fixes: https://github.com/nodejs/node/issues/43468 Reviewed-By: LiviaMedeiros <livia@cirno.name>
2022-06-27 16:31:44 +00:00
__JS_FLAVORED_DYNAMIC_CSS__
Adding build tools & templates/assets
2010-10-28 12:18:54 +00:00
</head>
Update template to use new token style Conflicts: doc/template.html
2012-02-27 18:59:51 +00:00
<body class="alt apidoc" id="api-section-__FILENAME__">
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
<div id="content" class="clearfix">
doc: add navigation ARIA landmark to doc ToC As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: https://github.com/nodejs/node/pull/49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>
2023-09-26 17:18:29 +00:00
<div role="navigation" id="column2" class="interior">
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-11 19:11:09 +00:00
<div id="intro" class="interior">
<a href="/" title="Go back to the home page">
doc: no Node.js(1) Node.js(1) does not make sense. Node(1) would, but this isn’t a `man` page. 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-12 17:25:44 +00:00
Node.js
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-11 19:11:09 +00:00
</a>
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
</div>
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-11 19:11:09 +00:00
__GTOC__
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
</div>
Nodejs.org design refresh.
2012-01-22 04:02:16 +00:00
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
<div id="column1" data-id="__ID__" class="interior">
doc,tools: improve navigability of API docs PR-URL: https://github.com/nodejs/node/pull/41404 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-02-24 11:00:42 +00:00
<header class="header">
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>
2020-11-22 10:54:56 +00:00
<div class="header-container">
doc: use sentence-style capitlaztion in template header Make the level one header for all the HTML documents use consistent capitalization style as the documentation itself. PR-URL: https://github.com/nodejs/node/pull/37837 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2021-03-20 13:03:12 +00:00
<h1>Node.js __VERSION__ documentation</h1>
doc: add tooltip for light/dark mode toggle PR-URL: https://github.com/nodejs/node/pull/37044 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-01-24 06:28:31 +00:00
<button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
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>
2020-11-22 10:54:56 +00:00
<svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
<path fill="none" d="M0 0h24v24H0z" />
<path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/>
<path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/>
</svg>
<svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
<path d="M0 0h24v24H0z" fill="none" />
<path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/>
</svg>
</button>
</div>
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
<div id="gtoc">
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-01-23 03:16:21 +00:00
<ul>
doc: make header smaller and dropdown click-driven when JS is on PR-URL: https://github.com/nodejs/node/pull/42165 Fixes: https://github.com/nodejs/node/issues/42286 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-03-22 21:31:56 +00:00
<li class="pinned-header">Node.js __VERSION__</li>
doc,tools: improve navigability of API docs PR-URL: https://github.com/nodejs/node/pull/41404 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-02-24 11:00:42 +00:00
__TOC_PICKER__
__GTOC_PICKER__
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-14 00:37:32 +00:00
__ALTDOCS__
doc,tools: improve navigability of API docs PR-URL: https://github.com/nodejs/node/pull/41404 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-02-24 11:00:42 +00:00
<li class="picker-header">
<a href="#">
doc: fix arrow vertical alignment in HTML version This commit fixes the alignment of the bullet points (green arrow) under 'Node.js <version> documentation' by drawing a triangle in CSS instead of using an ASCII char. PR-URL: https://github.com/nodejs/node/pull/52193 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
2024-03-27 23:35:22 +00:00
<span class="picker-arrow"></span>
doc,tools: improve navigability of API docs PR-URL: https://github.com/nodejs/node/pull/41404 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2022-02-24 11:00:42 +00:00
Options
</a>
<div class="picker">
<ul>
<li>
<a href="all.html">View on single page</a>
</li>
<li>
<a href="__FILENAME__.json">View as JSON</a>
</li>
__EDIT_ON_GITHUB__
</ul>
</div>
</li>
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-01-23 03:16:21 +00:00
</ul>
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
</div>
<hr>
</header>
Update template to use new token style Conflicts: doc/template.html
2012-02-27 18:59:51 +00:00
doc: remove TOC summary for pages with no TOC Remove the table of contents summary for pages with no table of contents. Currently, this affects at least index.html. PR-URL: https://github.com/nodejs/node/pull/37043 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-01-24 02:58:26 +00:00
__TOC__
Update template to use new token style Conflicts: doc/template.html
2012-02-27 18:59:51 +00:00
doc: add main ARIA landmark to API docs As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: https://github.com/nodejs/node/pull/49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>
2023-09-26 17:35:09 +00:00
<div role="main" id="apicontent">
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
__CONTENT__
doc,tools: syntax highlight api docs at compile-time Prior to this commit, API docs would be highlighted after the page loaded using `highlightjs`. This commit still uses `highlightjs`, but runs the generation during the compilation of the documentation, making it so no script needs to load on the client. This results in a faster load, as well as allowing the pages to fully functional even when JavaScript is turned off. PR-URL: https://github.com/nodejs/node/pull/34148 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-06-30 19:35:28 +00:00
<!-- API END -->
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
</div>
Nodejs.org design refresh.
2012-01-22 04:02:16 +00:00
</div>
doc: fix mixed content issues Explicitly specify "https" over "http" for linked CSS. Fixup indentation and quoting issues. PR-URL: https://github.com/iojs/io.js/pull/379 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
2015-01-14 08:00:59 +00:00
</div>
doc: fix invalid HTML in doc template Move the script tag for dark mode support inside the body tag. PR-URL: https://github.com/nodejs/node/pull/36930 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-01-14 16:56:09 +00:00
</body>
Bump to v0.5.1
2011-07-14 22:56:15 +00:00
</html>
Reference in New Issue Copy Permalink