{"id":23359945,"url":"https://github.com/restarian/brace_document_navlink","last_synced_at":"2025-04-07T20:47:57.139Z","repository":{"id":29242857,"uuid":"120213895","full_name":"restarian/brace_document_navlink","owner":"restarian","description":":arrow_down_small: A navigation link injector plugin for Brace Document :arrow_up_small:","archived":false,"fork":false,"pushed_at":"2022-02-11T01:11:13.000Z","size":288,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T03:34:14.090Z","etag":null,"topics":["documentation-generator","markdown-generator","navigation-links"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/restarian.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-04T19:03:52.000Z","updated_at":"2020-02-07T23:37:16.000Z","dependencies_parsed_at":"2022-08-07T14:15:44.736Z","dependency_job_id":null,"html_url":"https://github.com/restarian/brace_document_navlink","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restarian%2Fbrace_document_navlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restarian%2Fbrace_document_navlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restarian%2Fbrace_document_navlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restarian%2Fbrace_document_navlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/restarian","download_url":"https://codeload.github.com/restarian/brace_document_navlink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247729512,"owners_count":20986395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-generator","markdown-generator","navigation-links"],"created_at":"2024-12-21T11:12:31.115Z","updated_at":"2025-04-07T20:47:56.586Z","avatar_url":"https://github.com/restarian.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brace Document Navlink\n## Synopsis\n\n[![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)\n\n| **The [Brace Suite]** | **[Ubuntu on Windows]**   |\n|:---------------------:|:-------------------------:|\n| ![Brace logo]         | ![Ubuntu on Windows logo] |         |\n\n[Brace Suite]: https://github.com/restarian/restarian/tree/master/brace/\n[Ubuntu on Windows]: https://www.microsoft.com/en-us/store/p/ubuntu/9nblggh4msv6?activetab=pivot%3aoverviewtab\n\n[Ubuntu on Windows logo]: https://raw.githubusercontent.com/restarian/restarian/master/doc/image/ubuntu_windows_logo.png\n[Brace logo]: https://raw.githubusercontent.com/restarian/restarian/master/brace/doc/image/brace_logo_small.png\n\n---\n### Brace Document Navlink help pages\n* [Available options and usage](https://github.com/restarian/brace_document_navlink/blob/master/docs/available_options_and_usage.md)\n* [Contributor code of conduct](https://github.com/restarian/brace_document_navlink/blob/master/docs/contributor_code_of_conduct.md)\n* [Guidelines for contributing](https://github.com/restarian/brace_document_navlink/blob/master/docs/guidelines_for_contributing.md)\n* [How documents are modified](https://github.com/restarian/brace_document_navlink/blob/master/docs/how_documents_are_modified.md)\n* **Synopsis**\n* Specification\n  * [License information](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/license_information.md)\n  * [Package information](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/package_information.md)\n  * [Unit test output](https://github.com/restarian/brace_document_navlink/blob/master/docs/specification/unit_test_output.md)\n\n\n---\n\n**Bonuses:**\n* A fully asynchronous and idempotent API\n* Uses AMD (*asynchronous module definition*), syntax\n* Well commented, thoroughly unit tested and professional engineered scripting\n* Tested with Linux and Windows environments\n\n### What this plugin does\nThis 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*.\n\n### The document pages you are reading were processed with Brace document navlink too.\nA 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.\n\n### Below is an example of a markdown page before and after processing with the Brace document navlink plugin.\nBefore using the Brace document navlink plugin a markdown page would look like this:\n```markdown\n## The main page\n\nSome text about the project here\n```\n\n  After processing a projects docuemnts with the Brace Document Navlink plugin the navigation links would be added to the pages like below:\n```markdown\n\n## The main page\n\n---\n### Document pages\n\n---\n\nSome text about the project here\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frestarian%2Fbrace_document_navlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frestarian%2Fbrace_document_navlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frestarian%2Fbrace_document_navlink/lists"}