# brace_document_navlink > A Brace Document plugin which injects a navigation list into markdown documents Latest version **1.1.12** (published 2020-02-07) · MIT license · 0 weekly downloads ## Install ```sh npm install brace_document_navlink pnpm add brace_document_navlink yarn add brace_document_navlink bun add brace_document_navlink ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.12 | | Published | 2020-02-07 | | First published | 2018-02-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 114.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Robert Steckroth | | Maintainers | nickali | | Keywords | markdown, navigation, documentation, navbar, navlist, generation | ## Links - npm: https://www.npmjs.com/package/brace_document_navlink - Repository: https://github.com/restarian/brace_document_navlink - Homepage: https://github.com/restarian/brace_document_navlink#readme - Issues: https://github.com/restarian/brace_document_navlink/issues - npm.io page: https://npm.io/package/brace_document_navlink ## Dependencies (6) - [bracket_print](https://npm.io/package/bracket_print.md) ^0.10.4 - [bracket_utils](https://npm.io/package/bracket_utils.md) ^0.3.7 - [brace_document](https://npm.io/package/brace_document.md) ^1.1.10 - [brace_document_link](https://npm.io/package/brace_document_link.md) ^1.1.11 - [brace_document_mocha](https://npm.io/package/brace_document_mocha.md) ^1.1.3 - [brace_document_specification](https://npm.io/package/brace_document_specification.md) ^1.2.3 ## Alternatives - [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads - [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads - [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads - [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads - [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads ## Recent versions - 1.1.12 (latest) — 2020-02-07 - 1.1.9 — 2020-01-28 - 1.1.8 — 2020-01-28 - 1.1.7 — 2019-11-07 - 1.1.6 — 2019-11-05 - 1.1.3 — 2019-11-03 - 1.1.2 — 2019-11-03 - 1.1.1 — 2019-11-03 - 1.1.0 — 2019-11-02 - 1.0.2 — 2018-03-03 - 1.0.1 — 2018-03-03 - 1.0.0 — 2018-03-03 - 0.4.1 — 2018-03-02 - 0.3.13 — 2018-03-01 - 0.3.12 — 2018-03-01 - … 11 more at https://npm.io/package/brace_document_navlink/versions ## README # Brace Document Navlink ## Synopsis [![Build status](https://ci.appveyor.com/api/projects/status/vhqd52w3em2om16p/branch/master?svg=true)](https://ci.appveyor.com/project/restarian/brace-document-navlink/branch/master)[![Downloads](https://img.shields.io/npm/dm/brace_document_navlink.svg?svg=true)](https://npmjs.org/package/brace_document_navlink) | **The [Brace Suite]** | **[Ubuntu on Windows]** | |:---------------------:|:-------------------------:| | ![Brace logo] | ![Ubuntu on Windows logo] | | [Brace Suite]: https://github.com/restarian/restarian/tree/master/brace/ [Ubuntu on Windows]: https://www.microsoft.com/en-us/store/p/ubuntu/9nblggh4msv6?activetab=pivot%3aoverviewtab [Ubuntu on Windows logo]: https://raw.githubusercontent.com/restarian/restarian/master/doc/image/ubuntu_windows_logo.png [Brace logo]: https://raw.githubusercontent.com/restarian/restarian/master/brace/doc/image/brace_logo_small.png --- ### Brace Document Navlink help pages * [Available options and usage](https://github.com/restarian/brace_document_navlink/blob/master/docs/available_options_and_usage.md) * [Contributor code of conduct](https://github.com/restarian/brace_document_navlink/blob/master/docs/contributor_code_of_conduct.md) * [Guidelines for contributing](https://github.com/restarian/brace_document_navlink/blob/master/docs/guidelines_for_contributing.md) * [How documents are modified](https://github.com/restarian/brace_document_navlink/blob/master/docs/how_documents_are_modified.md) * **Synopsis** * Specification * [License information](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/license_information.md) * [Package information](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/package_information.md) * [Unit test output](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/unit_test_output.md) --- **Bonuses:** * A fully asynchronous and idempotent API * Uses AMD (*asynchronous module definition*), syntax * Well commented, thoroughly unit tested and professional engineered scripting * Tested with Linux and Windows environments ### What this plugin does This program provides plugin functionality for [Brace Document](https://npmjs.org/packages/brace_document) which injects navigation links into markdown pages using a two line denotation formula. Documents are collected from a directory within the project and a set of navigation link urls are injected which reference the relative location of the documents. The link urls are fully qualified to allow access from locations other than *github.com*. ### The document pages you are reading were processed with Brace document navlink too. A scripts entry in the *package.json* file runs the appropriate command to process these docs. Simply use *npm run make_docs -- -v* to re-generate these documents after a alteration was made to the *docs_raw* directory. ### Below is an example of a markdown page before and after processing with the Brace document navlink plugin. Before using the Brace document navlink plugin a markdown page would look like this: ```markdown ## The main page Some text about the project here ``` After processing a projects docuemnts with the Brace Document Navlink plugin the navigation links would be added to the pages like below: ```markdown ## The main page --- ### Document pages --- Some text about the project here ``` --- _Source: https://npm.io/package/brace_document_navlink · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._