summaryrefslogtreecommitdiff
path: root/doc/api/punycode.md
Commit message (Collapse)AuthorAgeFilesLines
* doc: format doc/api/*.md with markdown formatterRich Trott2021-10-201-1/+10
| | | | | | | | PR-URL: https://github.com/nodejs/node/pull/40403 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
* doc: anchor link parity between markdown and html-generated docsfoxxyz2021-08-301-2/+2
| | | | | | | | | | | | | | | | | | | | | | | Main changes: - Replace current HTML anchor generation to match header anchor generation in Github markdown. - Remove unnecessary double namespacing on generated anchors/links (E.G. `esm.md#loaders` instead of `esm.md#esm_loaders`). - Anchors/links are automatically prefixed with their respective modules when concatenated for usage in `all.html`. Benefits: - All anchor links within and between markdown API docs actually work. - Adding new anchor links no longer requires contributors to generate the HTML docs first to look up the correct anchors. - Anchors are much shorter. - All previous anchor links are preserved by generating hidden legacy anchors. PR-URL: https://github.com/nodejs/node/pull/39304 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
* doc: fix boldface punctuation for full sentencesRich Trott2021-07-071-1/+1
| | | | | | | | | | If an entire sentence is in boldface, then generally the terminating punctuation should as well. PR-URL: https://github.com/nodejs/node/pull/39278 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
* docs: add references to punycode.mdIsaac Levy2021-01-091-1/+5
| | | | | | | | | | | Add references to related `url` functions in punycode.md. These provide guidance to users who may be investigating the punycode module for URL encoding. PR-URL: https://github.com/nodejs/node/pull/36761 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Yash Ladha <yash@yashladha.in> Reviewed-By: James M Snell <jasnell@gmail.com>
* tools,doc: enforce alphabetical order for md refsAntoine du Hamel2020-09-221-1/+1
| | | | | | PR-URL: https://github.com/nodejs/node/pull/35244 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>
* doc: fix deprecation documentation inconsistenciesAntoine du HAMEL2020-09-161-4/+1
| | | | | PR-URL: https://github.com/nodejs/node/pull/35082 Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: add dynamic source code linksAlec Davidson2020-06-261-0/+2
| | | | | | | | Fixes: https://github.com/nodejs/node/pull/33977 PR-URL: https://github.com/nodejs/node/pull/33996 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc,punycode: use code markup/markdown in headersRich Trott2019-12-261-8/+8
| | | | | | PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
* doc: prevent some redirectionsVse Mozhet Byt2018-07-141-1/+1
| | | | | | | | | Replace some redirected URLs with the final ones. PR-URL: https://github.com/nodejs/node/pull/21811 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* doc: add and unify even more return valuesVse Mozhet Byt2018-04-121-0/+2
| | | | | | PR-URL: https://github.com/nodejs/node/pull/19955 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: specify definite Array typesVse Mozhet Byt2018-04-091-1/+1
| | | | | | | | Replace `{Array}` with `{type[]}`. PR-URL: https://github.com/nodejs/node/pull/19895 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* doc: remove **Note:** tagsJames M Snell2018-02-081-1/+1
| | | | | | | | | | | Remove the various **Note:** prefixes throughout the docs. PR-URL: https://github.com/nodejs/node/pull/18592 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
* doc: add links to alternative versions of docChris Young2017-08-281-0/+2
| | | | | | | | | | | | | 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>
* doc: sort bottom-of-file markdown linksSam Roberts2017-05-081-1/+1
| | | | | | | | PR-URL: https://github.com/nodejs/node/pull/12726 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
* doc: consistent case for primitive typesRoman Reiss2017-03-021-5/+5
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/11167 Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
* doc: add changelogs for punycodeAnna Henningsen2017-02-241-0/+6
| | | | | | | | | 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>
* doc: improve consistency in documentation titlesVse Mozhet Byt2017-02-091-1/+1
| | | | | | | | | | | | | Unify capitalization and spaces and add some info for consistency, clarity and coherence with sorting in the all.md / _toc.md. PR-URL: https://github.com/nodejs/node/pull/11230 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
* doc: use blockquotes for Stability: markersAnna Henningsen2016-08-041-1/+1
| | | | | | | | | | | | | | | Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (https://github.com/nodejs/node/pull/7729). PR-URL: https://github.com/nodejs/node/pull/7757 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc, punycode: soft-deprecation of the punycode moduleJames M Snell2016-08-031-1/+6
| | | | | | | | | | | | As discussed and agreed upon by the CTC, the punycode module bundled in core is soft-deprecated (docs only) for v7 with an eye towards hard-deprecation in v8 or later. Also see discussion in https://github.com/nodejs/node/pull/7552 PR-URL: https://github.com/nodejs/node/pull/7941 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
* doc: general improvements to punycode.md copyJames M Snell2016-06-021-23/+55
| | | | | PR-URL: https://github.com/nodejs/node/pull/7025 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
* doc: add `added:` information for punycodeDaniel Wang2016-05-191-1/+25
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/6805 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: git mv to .mdRobert Jefe Lindstaedt2016-04-201-0/+82
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: https://github.com/nodejs/node/pull/4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>