@metreeca/mark
v1.0.1
Published
A minimalist markdown document reader.
Readme
<link rel="home" href="/mark/"/>
<!-- `@{major}` and `@{major.minor}`) version ranges also supported -->
<link rel="icon" type="image/svg+xml"
href="https://cdn.jsdelivr.net/npm/@metreeca/[email protected]/dist/index.svg"/>
<link rel="stylesheet" type="text/css"
href="https://cdn.jsdelivr.net/npm/@metreeca/[email protected]/dist/index.css">
<script type="module"
src="https://cdn.jsdelivr.net/npm/@metreeca/[email protected]/dist/index.js"></script>
<!-- include to define top-level navigation links in the sidebar -->
<script type="application/json">
{
"Tutorials": "/tutorials/",
"How-To": "/how-to/",
"GitHub": "https://github.com/metreeca/mark"
}
</script>
</head>URL Rewriting
The loader will dynamically retrieve and render Markdown content as inferred from the current URL according to the following patterns:
| URL | Content | |------------------------------|-------------------------------------| | https://example.com/ | https://example.com/index.md | | https://example.com/folder/ | https://example.com/folder/index.md | | https://example.com/document | https://example.com/document.md |
Internal Markdown links in the Content format are automatically rewritten to the corresponding URL format.
Meta Placeholders
The loader will dynamically replace placeholder expression formatted like {{meta.<name>}} with the content defined by
the matching <meta name="<name>" content="<content>"> tag in the HTML loader document, for instance v1.0.1
with 1.2.3.
Support
- open an issue to report a problem or to suggest a new feature
- start a discussion to ask a how-to question or to share an idea
License
This project is licensed under the Apache 2.0 License – see LICENSE file for details.
