Markdown text documents minimal HTML wrapper and converter to use embedded

Description

The project name is the description. Uses Markdeep to change Markdown to HTML.

Getting started ("installing")

Add this library into your own project with the following Git commands (1):

cd <existing_repo>;
git submodule add https://gitlab.com/shareable-notes/markdown-text-minimal-wrapper.git .markdown-text-minimal-wrapper/;
git diff --cached --submodule;

and commit these changes then push them to any upstream (remote) repository.

To clone your project with this library within, you must initialise and update the submodule too.

git submodule update --init --recursive;
# git submodule update --remote; # Use this to fetch and merge new commits to this submodule library.

Usage

In your project, use generate.sh, with
one or more < file-name > ending in any of ( .md , .md.html ), this should output ⤵️
static HTML files in the output directory.

At the present time, the Markdeep rasterizer does not work when tested,
so every Markdeep-wrapped Markdown page in HTML ( .md.html ) in the output/.wrapped directory
may be used after being output, without users then having a static version of the
output Markdeep Markdown HTML documents if they are without JavaScript
(but the HTML document should show with the Markdown text passed through as plain text).

Example:

./.markdown-text-minimal-wrapper/generate.sh markdown-document.md
-> ./.markdown-text-minimal-wrapper/output/wrapped/markdown-document.md.html

Support, contributions or feedback

Open an issue please.

Acknowledgments

Markdeep JavaScript.

Markdeep Rasterizer Node.js® package.

Open source license

The Source Code Form (of this project work, not the Markdeep rasterizer module it uses) is subject to the terms of the Mozilla Public License, version 2.0, or subsequent versions.
The MPL-2.0 licensed Covered Software in the Source Code Form is "Incompatible With Secondary Licenses"
(to NOT distribute this Covered Software under the terms of such licenses of a Larger Work),
as defined by the Mozilla Public License, version 2.0.