Metreeca/Mark is a minimalist reader for static Markdown document sites. It doesn't require complex setups, specific site layouts or release-time static site generation: just throw in a couple of Markdown pages and let the reader take care of the details…
Create Markdown content using your favourite editor; the following markdown extensions are supported:
Warning
Make sure to use relative links to refer to images and related content.
Define a HTML file to be served by your deployment environment as fallback content for unknown routes. For GitHub Pages
that would be a 404.html file in the root of your source branch/folder.
Warning
When deploying to GitHub Pages, make sure to include a .nojekyll file.
Include a head element according to the following (all meta/linkelements are optional).
<!DOCTYPE html>
<html lang="en">
<head>
<title>Metreeca/Mark</title>
<meta name="version" content="v1.0.0">
<meta name="description" content="A minimalist Markdown document reader">
<meta name="creator" content="https://www.metreeca.com/">
<meta name="copyright" content="© 2020-2024 Metreeca">
<meta name="license" content="Creative Commons BY-NC-SA 4.0 License">
<meta name="license:uri" content="https://creativecommons.org/licenses/by-nc-sa/4.0/">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#786">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<!-- define if deployed to a subfolder -->
<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/mark@v1.0.0/dist/index.svg"/>
<link rel="stylesheet" type="text/css"
href="https://cdn.jsdelivr.net/npm/@metreeca/mark@v1.0.0/dist/index.css">
<script type="module"
src="https://cdn.jsdelivr.net/npm/@metreeca/mark@v1.0.0/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>
</html>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.
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.0
with 1.2.3.
- 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
This project is licensed under the Apache 2.0 License – see LICENSE file for details.
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)