https://github.com/restarian/brace_document_navlink

:arrow_down_small: A navigation link injector plugin for Brace Document :arrow_up_small:
https://github.com/restarian/brace_document_navlink

documentation-generator markdown-generator navigation-links

Last synced: about 1 year ago
JSON representation

:arrow_down_small: A navigation link injector plugin for Brace Document :arrow_up_small:

• Host: GitHub
• URL: https://github.com/restarian/brace_document_navlink
• Owner: restarian
• Created: 2018-02-04T19:03:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T01:11:13.000Z (over 4 years ago)
• Last Synced: 2025-03-16T03:34:14.090Z (over 1 year ago)
• Topics: documentation-generator, markdown-generator, navigation-links
• Language: JavaScript
• Homepage:
• Size: 281 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

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

```