{"_id":"@alandefreitas/antora-cpp-reference-extension","_rev":"3-6b45c5fd5f343cff24847d053147f207","name":"@alandefreitas/antora-cpp-reference-extension","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@alandefreitas/antora-cpp-reference-extension","version":"0.0.1","keywords":["antora","extension","c++","reference","documentation"],"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","_id":"@alandefreitas/antora-cpp-reference-extension@0.0.1","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"homepage":"https://github.com/alandefreitas/antora-cpp-reference-extension#readme","bugs":{"url":"https://github.com/alandefreitas/antora-cpp-reference-extension/issues"},"dist":{"shasum":"7da39be03e431822290a96bb9d645e70eb52ef93","tarball":"https://registry.npmjs.org/@alandefreitas/antora-cpp-reference-extension/-/antora-cpp-reference-extension-0.0.1.tgz","fileCount":21,"integrity":"sha512-6DOPrTLKNturLUQ2aUTqYLdAYi35jmu1JmeGSxFG0AwHRyoaB50eNGnYQf/gjy4nZbUekUGbE3TxmXZy4Bq0dQ==","signatures":[{"sig":"MEUCIG3OQi9YpPOGtR5GiwhABKQ9EPDVcOXt1yeZ8Zz3RWvfAiEAqAE9EW3W5fYLfhdTOwkpAfGZBkIyQWV6wXrOYp8fQAc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":175923},"main":"lib/extension.js","gitHead":"7b197fde3aa23a3e4d6743ba0d6675653420a6bb","scripts":{"test":"node test/extension.test.js","example":"cd example/doc && npm ci && npx antora --fetch local-playbook.yml --stacktrace --log-level all"},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"repository":{"url":"git+https://github.com/alandefreitas/antora-cpp-reference-extension.git","type":"git"},"_npmVersion":"10.7.0","description":"C++ Reference Extension for Antora","directories":{},"_nodeVersion":"20.15.1","dependencies":{"axios":"^1.7.2","js-yaml":"^4.1.0","fast-glob":"^3.3.2","isomorphic-git":"^1.27.1","cache-directory":"^2.0.0","@antora/expand-path-helper":"^2.0.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-cpp-reference-extension_0.0.1_1722565866342_0.29275339386360066","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.2":{"name":"@alandefreitas/antora-cpp-reference-extension","version":"0.0.2","keywords":["antora","extension","c++","reference","documentation"],"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","_id":"@alandefreitas/antora-cpp-reference-extension@0.0.2","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"homepage":"https://github.com/alandefreitas/antora-cpp-reference-extension#readme","bugs":{"url":"https://github.com/alandefreitas/antora-cpp-reference-extension/issues"},"dist":{"shasum":"f88072d6263b0a44955f8f1fee41727f5d871009","tarball":"https://registry.npmjs.org/@alandefreitas/antora-cpp-reference-extension/-/antora-cpp-reference-extension-0.0.2.tgz","fileCount":21,"integrity":"sha512-NtIUmB/sywzATA8gnZO8ZQ6PbslrCPlkg2Ag3yYtVZ2QoBR0QYGDnTtK+KMz/yXBvRfzL/YZJF3Zzzz1X89nvw==","signatures":[{"sig":"MEYCIQDLuQ0/FzMOmYpb46Al2ojuhaWjdLdaopLcdYjUkza7xAIhAMqmMrQ6jnx+s4WfVXbJGgzkbhBPIOnFXJrQTjCp3DE2","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":182483},"main":"lib/extension.js","gitHead":"bd6e1cab250a0aabb15ce7f85f884c68f9a981d8","scripts":{"test":"node test/extension.test.js","example":"cd example/doc && npm ci && npx antora --fetch local-playbook.yml --stacktrace --log-level all"},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"repository":{"url":"git+https://github.com/alandefreitas/antora-cpp-reference-extension.git","type":"git"},"_npmVersion":"10.8.2","description":"C++ Reference Extension for Antora","directories":{},"_nodeVersion":"20.17.0","dependencies":{"axios":"^1.7.2","js-yaml":"^4.1.0","fast-glob":"^3.3.2","isomorphic-git":"^1.27.1","cache-directory":"^2.0.0","@antora/expand-path-helper":"^2.0.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-cpp-reference-extension_0.0.2_1725996155661_0.15570620107820954","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.3":{"name":"@alandefreitas/antora-cpp-reference-extension","version":"0.0.3","keywords":["antora","extension","c++","reference","documentation"],"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","_id":"@alandefreitas/antora-cpp-reference-extension@0.0.3","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"homepage":"https://github.com/alandefreitas/antora-cpp-reference-extension#readme","bugs":{"url":"https://github.com/alandefreitas/antora-cpp-reference-extension/issues"},"dist":{"shasum":"f1eddd41a251320ddd85f07bdf65ad2485230e08","tarball":"https://registry.npmjs.org/@alandefreitas/antora-cpp-reference-extension/-/antora-cpp-reference-extension-0.0.3.tgz","fileCount":21,"integrity":"sha512-tgshdhPzjlfBaRG11jACMH9R4apAogTHAP2Y57qTj9m1YzeZqABNTRwor7uTCgB27bGLnWM73tT8EqguBEJ+yQ==","signatures":[{"sig":"MEYCIQCgtZCME3ivgEIakyPMydXYHX4PUY1lodVFbW5gUwS3TQIhAMdTS6Ex0A3zLD9BH4igXc/2/IIjh2Jy3WavWpwUQnTs","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":184306},"main":"lib/extension.js","gitHead":"a66a5ce9048db4875b2110631dff25bb7bc1a603","scripts":{"test":"node test/extension.test.js","example":"cd example/doc && npm ci && npx antora --fetch local-playbook.yml --stacktrace --log-level all"},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"repository":{"url":"git+https://github.com/alandefreitas/antora-cpp-reference-extension.git","type":"git"},"_npmVersion":"10.8.2","description":"C++ Reference Extension for Antora","directories":{},"_nodeVersion":"20.17.0","dependencies":{"axios":"^1.7.2","js-yaml":"^4.1.0","fast-glob":"^3.3.2","isomorphic-git":"^1.27.1","cache-directory":"^2.0.0","@antora/expand-path-helper":"^2.0.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-cpp-reference-extension_0.0.3_1726174019221_0.5739058871005314","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2024-08-02T02:31:06.254Z","modified":"2024-09-24T21:51:39.483Z","0.0.1":"2024-08-02T02:31:06.585Z","0.0.2":"2024-09-10T19:22:35.832Z","0.0.3":"2024-09-12T20:46:59.426Z"},"bugs":{"url":"https://github.com/alandefreitas/antora-cpp-reference-extension/issues"},"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","homepage":"https://github.com/alandefreitas/antora-cpp-reference-extension#readme","keywords":["antora","extension","c++","reference","documentation"],"repository":{"url":"git+https://github.com/alandefreitas/antora-cpp-reference-extension.git","type":"git"},"description":"C++ Reference Extension for Antora","maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"readme":"This extension generates reference documentation for C++ symbols in your\ncodebase and creates an Antora module with its pages.\n\nThis extension populates the Antora pages with a reference module that\ncontains the reference documentation for the C++ symbols in your\ncodebase.\n\nConfiguration {#_configuration}\n=============\n\nnpm {#_npm}\n---\n\nInstall this extension\n\n``` {.bash}\nnpm i -D @alandefreitas/antora-cpp-reference-extension\n```\n\nRequirements {#_requirements}\n------------\n\nBefore building the Antora playbook, make sure you have the following\ninstalled:\n\n-   A C++ compiler (preferably Clang)\n\n-   `7z` (Windows) or `tar` (Linux)\n\n-   `git`\n\nPlaybook {#_playbook}\n--------\n\nAppend the following in your `playbook.yaml`:\n\n``` {.yaml}\nantora:\n  extensions:\n    - require: '@alandefreitas/antora-cpp-reference-extension' # \n      dependencies: # \n        - name: 'boost'\n          repo: 'https://github.com/boostorg/boost.git'\n          tag: 'develop'\n          variable: 'BOOST_SRC_ROOT'\n          system-env: 'BOOST_SRC_ROOT' # \n```\n\n-   \\<1\\> `npm` package name:\n    `@alandefreitas/antora-cpp-reference-extension` (required)\n\n-   \\<2\\> List of dependencies to be downloaded and extracted. The\n    directory where these dependencies are extracted will be available\n    to all components as an environment variable.\n\n-   \\<3\\> The name of the environment variable describing where the path\n    can be found. If this path exists and is a valid directory, it will\n    be used as the source root for the dependency, skipping the download\n    and extraction steps. If this is different from `variable`, the\n    extension will set the value of `variable` to the path where the\n    dependency is already located.\n\nComponents {#_components}\n----------\n\nComponents that will include reference documentation should set the path\nof the MrDocs configuration file. Append following in your\n`antora.yaml`:\n\n``` {.yaml}\next:\n  cpp-reference:\n    config: doc/mrdocs.yml # \n```\n\n-   \\<1\\> The path to the MrDocs configuration file relative to the\n    worktree.\n\nFor more information about MrDocs, see <https://www.mrdocs.com/docs>\n\nReferences in the component {#_references_in_the_component}\n---------------------------\n\nTo include links to the reference module, the prefix `xref:reference:`\nshould be used.\n\nYou would usually include a link to the main reference page in the\ncomponent's `nav.adoc`:\n\n``` {.asciidoc}\n* xref:reference:index.adoc[Reference]\n```\n\nExample {#_example}\n=======\n\nThe `example` directory contains an example project with a component\nthat uses the extension.\n","readmeFilename":"README.md"}