Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: allow <code> in header elements #31086

Merged
merged 44 commits into from Dec 27, 2019
Merged

doc: allow <code> in header elements #31086

merged 44 commits into from Dec 27, 2019

Commits on Dec 27, 2019

  1. doc: allow <code> in header elements 

    Allow use of <code> in header elements without styling side effects. We
can add styling later if desired. The goal here is to allow code to be
set off in markdown without needing to escape characters and do lint
exceptions for terms. This is probably a win in terms of accessibility
too although it would be moreso if we had some visual differentiation
for <code> inside of headers. As mentioned above, that can always be
added at a later time.

PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    fdec6bd View commit details
    Browse the repository at this point in the history

  2. doc,dns: use code markup/markdown in headers 

    This will allow us to lint for use of `hostname` in prose without
flagging `hostname` in code within headers. This also allows us to
remove backslash escaping for `[` and `]` inside of header code, which
makes the bare markdown more readable.

PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    5998523 View commit details
    Browse the repository at this point in the history

  3. doc: use code markup/markdown in headers in addons documentation 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    d0f9585 View commit details
    Browse the repository at this point in the history

  4. doc,assert: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    b5834a4 View commit details
    Browse the repository at this point in the history

  5. doc,async_hooks: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    a5eb139 View commit details
    Browse the repository at this point in the history

  6. doc,buffer: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    5847a4d View commit details
    Browse the repository at this point in the history

  7. doc,child_process: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    19419a4 View commit details
    Browse the repository at this point in the history

  8. doc,cluster: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    4459988 View commit details
    Browse the repository at this point in the history

  9. doc,console: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    adc9fa2 View commit details
    Browse the repository at this point in the history

  10. doc,crypto: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    f6b6701 View commit details
    Browse the repository at this point in the history

  11. doc: use code markup/markdown in headers in deprecations documentation 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    8e7d61e View commit details
    Browse the repository at this point in the history

  12. doc,dgram: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    0c8ff7c View commit details
    Browse the repository at this point in the history

  13. doc,domain: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    75ab328 View commit details
    Browse the repository at this point in the history

  14. doc,errors: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    57f7537 View commit details
    Browse the repository at this point in the history

  15. doc,esm: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    b3ff048 View commit details
    Browse the repository at this point in the history

  16. doc,events: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    36edbde View commit details
    Browse the repository at this point in the history

  17. doc,fs: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    b407503 View commit details
    Browse the repository at this point in the history

  18. doc: use code markup/markdown in headers in globals documentation 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    6f5e765 View commit details
    Browse the repository at this point in the history

  19. doc,http: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    f8795db View commit details
    Browse the repository at this point in the history

  20. doc,http2: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    2d6949d View commit details
    Browse the repository at this point in the history

  21. doc,https: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    fe4a7a2 View commit details
    Browse the repository at this point in the history

  22. doc,inspector: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    fc94934 View commit details
    Browse the repository at this point in the history

  23. doc,module: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    248f057 View commit details
    Browse the repository at this point in the history

  24. doc,net: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    933fd9b View commit details
    Browse the repository at this point in the history

  25. doc,os: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    24f24d9 View commit details
    Browse the repository at this point in the history

  26. doc,path: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    a70c3ab View commit details
    Browse the repository at this point in the history

  27. doc,perf_hooks: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    c956cab View commit details
    Browse the repository at this point in the history

  28. doc,process: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    fc0aa3f View commit details
    Browse the repository at this point in the history

  29. doc,punycode: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    1c33523 View commit details
    Browse the repository at this point in the history

  30. doc,querystring: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    d592efe View commit details
    Browse the repository at this point in the history

  31. doc,readline: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    8b89c89 View commit details
    Browse the repository at this point in the history

  32. doc,repl: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    85aed3e View commit details
    Browse the repository at this point in the history

  33. doc,stream: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    7034a3e View commit details
    Browse the repository at this point in the history

  34. doc,string_decoder: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    cdb727d View commit details
    Browse the repository at this point in the history

  35. doc,timers: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    7bb1f47 View commit details
    Browse the repository at this point in the history

  36. doc,tls: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    e11b327 View commit details
    Browse the repository at this point in the history

  37. doc,tty: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    a80d4ac View commit details
    Browse the repository at this point in the history

  38. doc,url: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    79f6412 View commit details
    Browse the repository at this point in the history

  39. doc,zlib: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    d9004da View commit details
    Browse the repository at this point in the history

  40. doc,util: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    ff6e7a0 View commit details
    Browse the repository at this point in the history

  41. doc,v8: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    ae4cd76 View commit details
    Browse the repository at this point in the history

  42. doc,worker: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    deb0c81 View commit details
    Browse the repository at this point in the history

  43. doc,vm: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    257a5dd View commit details
    Browse the repository at this point in the history

  44. doc,wasi: use code markup/markdown in headers 

    PR-URL: nodejs#31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 27, 2019
    Copy the full SHA
    b46efa9 View commit details
    Browse the repository at this point in the history