{"_id":"@alandefreitas/asciidoctor-boost-links","_rev":"1-e5a9263cab420a0f6c9750d2f1183916","name":"@alandefreitas/asciidoctor-boost-links","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@alandefreitas/asciidoctor-boost-links","version":"0.0.1","keywords":["asciidoctor","extension","boost","reference","documentation"],"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","_id":"@alandefreitas/asciidoctor-boost-links@0.0.1","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"homepage":"https://github.com/alandefreitas/asciidoctor-boost-links#readme","bugs":{"url":"https://github.com/alandefreitas/asciidoctor-boost-links/issues"},"dist":{"shasum":"20b6e456afc7cb592544eafae52b43f01b09377c","tarball":"https://registry.npmjs.org/@alandefreitas/asciidoctor-boost-links/-/asciidoctor-boost-links-0.0.1.tgz","fileCount":8,"integrity":"sha512-qrtRYDKTcifTbDg7uOv/bz3Sbnn8dHyLziOgyCqDDk2m0QpSS4wqkxeE4eVZCmPmWlLHrmwD0v+WnUCi5OQwRg==","signatures":[{"sig":"MEUCIBOHX4olJJg37A/OCRI2gLV90/U0B4hB1OdJOENyZ0a3AiEA6cNPKl2jL0GD/oLR/8eVNoodLOj8cKosAcFtWliKJuk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25356},"main":"lib/extension.js","gitHead":"87a8415c54c6357fc5fe890d01cdcf8972489167","scripts":{"test":"node --test"},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"repository":{"url":"git+https://github.com/alandefreitas/asciidoctor-boost-links.git","type":"git"},"_npmVersion":"10.7.0","description":"Asciidoctor extension to generates links to Boost library docs","directories":{},"_nodeVersion":"20.15.1","_hasShrinkwrap":false,"devDependencies":{"asciidoctor":"^3.0.4"},"_npmOperationalInternal":{"tmp":"tmp/asciidoctor-boost-links_0.0.1_1722383224056_0.3817876576349988","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2024-07-30T23:47:03.979Z","modified":"2024-09-24T21:51:26.929Z","0.0.1":"2024-07-30T23:47:04.206Z"},"bugs":{"url":"https://github.com/alandefreitas/asciidoctor-boost-links/issues"},"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","homepage":"https://github.com/alandefreitas/asciidoctor-boost-links#readme","keywords":["asciidoctor","extension","boost","reference","documentation"],"repository":{"url":"git+https://github.com/alandefreitas/asciidoctor-boost-links.git","type":"git"},"description":"Asciidoctor extension to generates links to Boost library docs","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"readme":"This extension creates links to Boost libraries and tools with inline\nAsciidoc syntax.\n\n``` {.asciidoc}\nboost:core[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/libs/core[Boost.Core]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.Core](https://www.boost.org/libs/core)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/libs/core\">Boost.Core</a>\n```\n\nThe extension supports Boost libraries and tools.\n\nConfiguration {#_configuration}\n=============\n\nnpm {#_npm}\n---\n\nInstall this extension\n\n``` {.bash}\nnpm i -D @alandefreitas/asciidoctor-boost-links\n```\n\nAsciiDoc {#_asciidoc}\n--------\n\nTo use this extension with the `asciidoctor` javascript library, you\nneed to include the extension in the `Asciidoctor` object.\n\n``` {.javascript}\nimport BoostLinksExtension from '@alandefreitas/asciidoctor-boost-links'\nconst processor = Asciidoctor()\nprocessor.Extensions.register(BoostLinksExtension)\nconst result = processor.convert(`boost:core[]`)\n```\n\nAntora Playbook {#_antora_playbook}\n---------------\n\nTo use this extension with Antora, include the extension in the\n`asciidoc.extensions` array in the `antora-playbook.yaml` file.\n\n``` {.yaml}\nasciidoc:\n  extensions:\n    - '@alandefreitas/asciidoctor-boost-links'\n```\n\nFeatures {#_features}\n========\n\nLinks to Libraries {#_links_to_libraries}\n------------------\n\nThe extension helps you create links to Boost libraries. The format is\nvery similar to the syntax for URLs in Asciidoc. However, the extension\nwill automatically convert the library name to the appropriate URL and\ndisplay the library name if the positional argument is not provided.\n\n``` {.asciidoc}\nboost:core[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/libs/core[Boost.Core]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.Core](https://www.boost.org/libs/core)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/libs/core\">Boost.Core</a>\n```\n\nBoost Tools {#_boost_tools}\n-----------\n\nBoost tools, such as Boost.Docca, have different link formats. The\nextension will identify the tool and render the link accordingly.\n\n``` {.asciidoc}\nboost:docca[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/tools/docca[Boost.Docca]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.Docca](https://www.boost.org/tools/docca)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/tools/docca\">Boost.Docca</a>\n```\n\nUnknown libraries {#_unknown_libraries}\n-----------------\n\nUnknown libraries render as if the library exists:\n\n``` {.asciidoc}\nboost:a[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/libs/a[Boost.A]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.A](https://www.boost.org/libs/a)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/libs/a\">Boost.A</a>\n```\n\nPositional arguments {#_positional_arguments}\n--------------------\n\nPositional arguments allow you to specify the text to display in the\nlink.\n\n``` {.asciidoc}\nboost:boostdep[Dependencies]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/tools/boostdep[Dependencies]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Dependencies](https://www.boost.org/tools/boostdep)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/tools/boostdep\">Dependencies</a>\n```\n\nForwarding attributes {#_forwarding_attributes}\n---------------------\n\nIf any attributes are passed to the link, they will be forwarded to the\ngenerated link.\n\n``` {.asciidoc}\nboost:quickbook[Quickbook,window=_blank]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/tools/quickbook[Quickbook,window=_blank]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Quickbook,window=\\_blank](https://www.boost.org/tools/quickbook)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/tools/quickbook\" target=\"_blank\" rel=\"noopener\">Quickbook</a>\n```\n\nIt also works when no text is provided:\n\n``` {.asciidoc}\nboost:utility[window=_blank]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/libs/utility[Boost.Utility,window=_blank]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.Utility,window=\\_blank](https://www.boost.org/libs/utility)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/libs/utility\" target=\"_blank\" rel=\"noopener\">Boost.Utility</a>\n```\n\nExceptions to Pascal Case {#_exceptions_to_pascal_case}\n-------------------------\n\nA few libraries and tools have exceptions to the Pascal Case rule (the\n\\\"Boost.LibraryName\\\" format). These exceptions are defined when\nrequested by library authors or when the Pascal Case format is\nproblematic. The extension will identify these exceptions and render the\nlink accordingly.\n\n``` {.asciidoc}\nboost:build[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/tools/build[B2]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[B2](https://www.boost.org/tools/build)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/tools/build\">B2</a>\n```\n\nOr Boost.URL, where the library name is an acronym:\n\n``` {.asciidoc}\nboost:url[]\n```\n\nThis will render as if the equivalent AsciiDoc code was used:\n\n``` {.asciidoc}\nhttps://www.boost.org/libs/url[Boost.URL]\n```\n\nWhen processed by Asciidoc, this renders as\n\\\"[Boost.URL](https://www.boost.org/libs/url)\\\":\n\n``` {.html}\n<a href=\"https://www.boost.org/libs/url\">Boost.URL</a>\n```\n","readmeFilename":"README.md"}