Commit Graph
44 Commits
Author SHA1 Message Date
Node.js GitHub Bot 43e5798283 tools: update doc to unist-util-select@5.0.0 unist-util-visit@5.0.0
PR-URL: https://github.com/nodejs/node/pull/48714
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2023-07-11 16:27:23 +00:00
Node.js GitHub Bot 6287d4d3f8 tools: update doc to to-vfile@8.0.0
PR-URL: https://github.com/nodejs/node/pull/48485
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
2023-06-18 06:12:23 +00:00
Node.js GitHub Bot 6b8d72513c tools: update doc to remark-parse@10.0.2
PR-URL: https://github.com/nodejs/node/pull/48095
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2023-05-23 00:49:37 +00:00
Node.js GitHub Bot 8587e3b369 tools: update doc to highlight.js@11.8.0
PR-URL: https://github.com/nodejs/node/pull/47786
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2023-05-02 00:48:08 +00:00
Node.js GitHub Bot 583bca51ab tools: update doc to remark-html@15.0.2 to-vfile@7.2.4
PR-URL: https://github.com/nodejs/node/pull/46622
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2023-02-12 16:32:09 +00:00
Node.js GitHub Bot 59e2304f63 tools: update doc to unist-util-select@4.0.3 unist-util-visit@4.1.2
PR-URL: https://github.com/nodejs/node/pull/46364
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2023-01-30 08:01:32 +00:00
Node.js GitHub Bot 8b594e0f12 tools: update doc to unist-util-select@4.0.2
PR-URL: https://github.com/nodejs/node/pull/46038
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2023-01-01 16:48:29 +00:00
Node.js GitHub Bot c98a10f43f tools: update doc to highlight.js@11.7.0
PR-URL: https://github.com/nodejs/node/pull/45636
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2022-11-29 00:51:47 +00:00
Node.js GitHub Bot be1b75b4ec tools: update doc to unist-util-visit@4.1.1
PR-URL: https://github.com/nodejs/node/pull/44370
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
2022-08-28 06:21:23 +00:00
Node.js GitHub Bot c52b722775 tools: update doc to highlight.js@11.6.0
PR-URL: https://github.com/nodejs/node/pull/43870
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2022-07-19 21:27:58 +01:00
Node.js GitHub Bot c3a581c360 tools: update doc to highlight.js@11.5.1
PR-URL: https://github.com/nodejs/node/pull/42758
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-04-17 07:44:36 +01:00
Node.js GitHub Bot 7a601f9cc5 tools: update doc to highlight.js@11.5.0 unified@10.1.2
PR-URL: https://github.com/nodejs/node/pull/42315
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joe Sepi <sepi@joesepi.com>
2022-03-14 18:47:33 +00:00
Node.js GitHub Bot fadd442fb5 tools: update doc to rehype-stringify@9.0.3
PR-URL: https://github.com/nodejs/node/pull/41854
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
2022-02-05 12:43:00 +00:00
Node.js GitHub Bot 5f4f8d417a tools: update doc to highlight.js@11.4.0 to-vfile@7.2.3
PR-URL: https://github.com/nodejs/node/pull/41441
Reviewed-By: Rich Trott <rtrott@gmail.com>
2022-01-17 15:20:02 +00:00
Node.js GitHub Bot 513e9fd0b6 tools: update doc to rehype-raw@6.1.1
PR-URL: https://github.com/nodejs/node/pull/41367
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
2022-01-04 19:34:36 -08:00
Node.js GitHub Bot bc6072e28b tools: update doc to remark-rehype@10.1.0
PR-URL: https://github.com/nodejs/node/pull/41149
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-12-13 14:29:24 +01:00
Rich Trott 32f7218388 tools: update highlight.js to 11.3.1
PR-URL: https://github.com/nodejs/node/pull/41091
Fixes: https://github.com/nodejs/node/issues/41077
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-12-07 09:24:40 -08:00
Richard Lau c802c4b173 tools: rollback highlight.js
Recent upgrade of highlight.js has broken the docs build on the
withoutintl builds.

PR-URL: https://github.com/nodejs/node/pull/41078
Refs: https://github.com/nodejs/node/issues/41077
Refs: https://github.com/nodejs/node/pull/41036
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-12-04 12:19:21 +00:00
Rich Trott 42e13c2a10 tools: udpate packages in tools/doc
PR-URL: https://github.com/nodejs/node/pull/41036
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yash Ladha <yash@yashladha.in>
2021-12-02 13:14:19 -08:00
Rich Trott 179248a7b9 tools: udpate doc tools to accommodate GFM footnotes
PR-URL: https://github.com/nodejs/node/pull/40477
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-10-23 06:13:18 -07:00
Michaël Zasso 2b080cb23f tools: update doc generator dependencies
PR-URL: https://github.com/nodejs/node/pull/40042
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-09-18 16:32:44 +02:00
Michaël Zasso 8c905b81c1 tools: update remark-html to v13.0.2
PR-URL: https://github.com/nodejs/node/pull/40043
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-09-09 02:08:03 +00:00
Ben Halverson 74e319f210 tools: added remark-frontmatter
remark-frontmatter allows the use of frontmatter metadata in markdown
files

PR-URL: https://github.com/nodejs/node/pull/38717
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
2021-07-19 08:03:46 -07:00
Antoine du Hamel fdb097c4f4 tools: upgrade highlight.js to version 11.0.1
Refs: https://github.com/highlightjs/highlight.js/blob/main/VERSION_11_UPGRADE.md

PR-URL: https://github.com/nodejs/node/pull/39032
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-06-26 15:13:35 +00:00
Michaël ZassoandAntoine du Hamel de01f475d5 tools: update doctool dependencies, migrate to ESM
- Migrated to ESM because some dependencies now require it.
- Did not update `highlight.js` to v11 because it has many breaking
  changes.
- Used non-deprecated `highlight.js` API.

Refs: https://github.com/highlightjs/highlight.js/issues/2277
Fixes: https://github.com/nodejs/node/issues/38938
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/38966
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-06-14 08:22:00 -07:00
Michaël Zasso 5bf2737e13 tools: avoid pending deprecation in doc generator
`unist-util-find` depends on `lodash.iteratee` which uses
`process.binding()`.
Let's remove this dependency which is used in one place to do a very
simple thing.

PR-URL: https://github.com/nodejs/node/pull/37267
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-12 21:46:54 +01:00
Michaël Zasso 9883fe0114 tools: update doc tool dependencies
PR-URL: https://github.com/nodejs/node/pull/36844
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-01-11 08:13:23 +01:00
Michaël Zasso 8dbeac6c04 tools: update doc tool dependencies
PR-URL: https://github.com/nodejs/node/pull/36407
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-12-08 22:17:58 +00:00
Myles Borins f34866a61c tools: update highlight.js to 10.1.2
Refs: https://github.com/advisories/GHSA-vfrc-7r7c-w9mx

PR-URL: https://github.com/nodejs/node/pull/36309
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2020-11-29 20:27:23 -08:00
Rich Trott 6312193391 tools: bump unist-util-find@1.0.1 to unist-util-find@1.0.2
PR-URL: https://github.com/nodejs/node/pull/36106
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2020-11-20 04:55:54 -08:00
Rich Trott 088af0f98b tools: update doc tools to remark-parse@9.0.0
PR-URL: https://github.com/nodejs/node/pull/36049
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
2020-11-12 06:29:51 +00:00
Antoine du Hamel 0b8fdb70ac tools,doc: upgrade dependencies
PR-URL: https://github.com/nodejs/node/pull/35244
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
2020-09-22 10:25:36 -07:00
Francisco Ryan Tolmasky I fa2e460d0c 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-07-16 00:22:35 +02:00
tpoisseau f035f557d7 tools: doc: improve async workflow of generate.js
Use fs.promises for read and write file
Use unified().process wich is async instead processSync
html and json are write in parallel
errors are logged and exit process with `1` code

Fixes: https://github.com/nodejs/node/issues/30090

PR-URL: https://github.com/nodejs/node/pull/30106
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2019-10-27 10:08:22 +01:00
Rich Trott 2d8367a5c3 tools: update dependencies in tools/doc
This clears warnings from `npm audit`.

PR-URL: https://github.com/nodejs/node/pull/27927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-05-27 13:35:22 -07:00
Sam Ruby cba2c7a874 tools: update to mdast-util-to-hast v3.0.2
See https://github.com/syntax-tree/mdast-util-to-hast/pull/21

Note: I updated all of the tools/doc dependencies, not just this one,
and removed the previous workaround that was in place until this change
landed.

PR-URL: https://github.com/nodejs/node/pull/22140
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-10 10:26:29 -04:00
Sam Ruby 3ffd6892c4 tools: convert addon-verify to remark
This is the last use of the remark *module*. tools/remark-cli and
tools/remark-preset-lint-node remain.

PR-URL: https://github.com/nodejs/node/pull/21978
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-07-28 10:40:35 +03:00
Sam Ruby f41dd5592e tools: produce JSON documentation using unified/remark/rehype
PR-URL: https://github.com/nodejs/node/pull/21697
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-07-25 21:33:06 +03:00
Sam Ruby 946686521d tools: create HTML docs with unified/remark/rehype
PR-URL: https://github.com/nodejs/node/pull/21490
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2018-07-20 13:37:40 -07:00
Richard Littauer 887e2327ee tools: fix gitignore for tools/doc/
PR-URL: https://github.com/nodejs/node/pull/17224
Fixes: https://github.com/nodejs/node/issues/17216
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-11-24 10:24:37 -05:00
AJ Jordan 49e63ff4a4 tools: update package.json engine field
PR-URL: https://github.com/nodejs/node/pull/14165
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-07-14 13:49:22 -07:00
Daniel Wang 3f69ea53fd tools: update marked dependency
Update module marked. Customize renderer to remove id from heading.

PR-URL: https://github.com/nodejs/node/pull/6396
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-05-07 09:27:05 +02:00
Anna Henningsen 020968dd18 tools: add mock-y js-yaml dependency to doctool
Add a hack js-yaml module to the doctool dependencies that simply
loads the one that’s included with eslint.

This helps avoiding to check in the whole dependency tree into
the core repo.

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:09 +02:00
isaacs 964d03bc3f New documentation generation tool 2012-02-27 10:59:01 -08:00