-
Notifications
You must be signed in to change notification settings - Fork 0
Local_to_Remote_Link_Resolution
Since: 0.1.5, core (flexmark) feature
[link](./foo.md) => <a href="https://www.jive.com/DOC-1234">link</a>
Any remote that uses alexandria-flexmark for conversion will automatically
resolve any github style local repository links to the documents remote URI. Only documents
that are indexed by Alexandria will be considered. If the document has been
indexed but has no remote URI, the link will be left alone. Alexandria
accounts for this automatically by doing a two pass sync which allows new
documents to be created on the first pass, and relative links to resolve
properly on the second.
Currently, the pattern matching for the link resolver is pretty simple, it
will only match basic Github style links, e.g. [some doc](./foo.md). Links
with anchors are not supported, nor reference-style links
| Technically Valid Github Markdown | Alexandria Supported |
|---|---|
[I'm a reference-style link][Arbitrary case-insensitive reference text]
...
[arbitrary case-insensitive reference text]: ./foo.md |
No |
[You can use numbers for reference-style link definitions][1]
...
[1]: ./foo.md |
No |
Or leave it empty and use the [link text itself].
...
[link text itself]: ./foo.md |
No |
What about [anchor links](./foo.md#Some-Section). |
No |
Supported links may be added in the future, see issue #54.
Since: 0.1.5, core feature
| Property | Default Value |
|---|---|
| disclaimerFooterEnabled | true |
| disclaimerFooterPath | null (use Alexandria default disclaimer) |
Alexandria can add a disclaimer footer to each converted file warning readers that they are not viewing the source of the document and that changes made will be overwritten.
A separator will be added between the document contents and the footer, so custom headers dont need to do any special spacing or dividers to distinguish the footer from the document contents. There is no way to customize this or disable it.
<p/>
---Which should render as a break and a divider between the document content and the footer.
A static disclaimer will be used by default:
<p/>
---
This file is managed by [Alexandria](https://github.com/macgregor/alexandria),
any changes made here will be overwritten.Users can provide a file path to a markdown document to use in place of the default header. Like all markdown files Alexandria works with, this file should be stored in the directory/repository Alexandria is managing and the filepath should be relative to the root directory. Remember that the separator will still be added between the document contents and the custom footer so there is no need to add any explicit separator in your custom footer.