bdn

brace_document_navlink

🔽 A navigation link injector plugin for Brace Document 🔼

Showing:

Popularity

Downloads/wk

6

GitHub Stars

1

Maintenance

Last Commit

2yrs ago

Contributors

1

Package

Dependencies

6

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Brace Document Navlink

Synopsis

Build statusDownloads

The Brace SuiteUbuntu on Windows
Brace logoUbuntu on Windows logo


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 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.

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.

Before using the Brace document navlink plugin a markdown page would look like this:

## 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:


## The main page

---
### Document pages

---

Some text about the project here

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial