@nence/markdown
v1.0.0
Published
Simple implementation markdown renderer.
Downloads
25
Maintainers
nenceReadme
@nence/markdown
- Simple implementation markdown renderer.
Feature
- Support for diagrams such as mermaid, pintora, plantuml.
- Support for import.
- By customizeng the class, you can read markdown files from the database.
- By customizing the class, the output of link and image tags can be changed.
Install
npm install @nence/markdownRun example
- Download and extrace source
- https://github.com/codesmith666/markdown/archive/refs/heads/main.zip
- Install the Dev Containers plugin in VSCode and open the directory.
- Open a terminal in VSCode...
- npm install
- cd example
- npm install
- npm run dev
- Open localhost 8080 in a browser.
Sample
- About css.nence
- see https://github.com/codesmith666/markdown/blob/main/example/css.nence.ts
- About css.prism
- see https://github.com/codesmith666/markdown/blob/main/example/css.prism.ts
import express from "express";
import { css_prism } from "./css.prism";
import { css_nence } from "./css.nence";
import { MarkdownFS } from "../src/index.js";
const selfPath = import.meta.url;
const app = express();
app.get("/", async (req, res) => {
// Create root path.Put markdown file here.
let root = "";
if (selfPath.startsWith("file://")) root = selfPath.slice(7);
if (selfPath.endsWith("/index.ts")) root = root.slice(0, -9);
root += "/markdown";
// 0.Since you are using express, run `npm install express`.
// 1.Specify the document root to the MarkdownFS class.
// 2.Get the name of the markdown file to be displayed from the query string.
// The extension may be omitted.
// 3.Rendering yields HTML (to be processed by await or then).
// 4.Returns a response by specifying an html tag or a head tag.
const md = new MarkdownFS(root);
const fn = (req.query["md"] as string | undefined) || "main";
const body = await md.render(fn);
const html = `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<style type="text/css">
${css_prism}
${css_nence}
</style>
</head>
<body>
${body}<br/>
EOF
</body>
</html>
`;
res.end(html);
});
const port = 8080;
app.listen(port, () => {
console.log(`Listening on port ${port}`);
});Apply
- If derived from the Book class, markdowns can be obtained from sources other than the file system.
- You can see it in the MarkdownFS implementation.
- https://github.com/codesmith666/markdown/blob/main/src/markdown/MarkdownFS.ts
The comments in the source
- The comments in the source are not yet fully written, and most are in Japanese.
- I'll get it into English eventually(Use deepl).