From 027db0f7d07c8f336f241bbe15ede3d0440cd195 Mon Sep 17 00:00:00 2001 From: Julien Oculi Date: Tue, 4 Jun 2024 18:30:12 +0200 Subject: [PATCH] feat: render `md` files using `gfm` --- deno.json | 1 + deno.lock | 1 + docs/all_symbols.html | 34 +++- docs/index.html | 10 +- docs/render_gfm.ts/~/index.html | 119 +++++++++++++ docs/render_gfm.ts/~/renderGfm.html | 264 ++++++++++++++++++++++++++++ docs/search_index.js | 2 +- docs/serve_file.ts/~/index.html | 10 +- docs/url_utils.ts/~/index.html | 10 +- docs/user_utils.ts/~/index.html | 10 +- src/render_gfm.ts | 28 +++ src/serve_file.ts | 16 +- 12 files changed, 482 insertions(+), 23 deletions(-) create mode 100644 docs/render_gfm.ts/~/index.html create mode 100644 docs/render_gfm.ts/~/renderGfm.html create mode 100644 src/render_gfm.ts diff --git a/deno.json b/deno.json index 0ccfee0..b09be30 100644 --- a/deno.json +++ b/deno.json @@ -12,6 +12,7 @@ "useTabs": true }, "imports": { + "@deno/gfm": "jsr:@deno/gfm@^0.8.2", "@std/media-types": "jsr:@std/media-types@^0.224.1", "@std/path": "jsr:@std/path@^0.225.2" } diff --git a/deno.lock b/deno.lock index 7a2b3ea..add9b4f 100644 --- a/deno.lock +++ b/deno.lock @@ -24,6 +24,7 @@ "remote": {}, "workspace": { "dependencies": [ + "jsr:@deno/gfm@^0.8.2", "jsr:@std/media-types@^0.224.1", "jsr:@std/path@^0.225.2" ] diff --git a/docs/all_symbols.html b/docs/all_symbols.html index 6b289de..5ffe625 100644 --- a/docs/all_symbols.html +++ b/docs/all_symbols.html @@ -35,7 +35,39 @@
-
+
+
f
+
+ renderGfm + +
No documentation available
+
+
+
+

Symbols

 - view all 9 symbolsview all 10 symbols + + + Index - Portfolio Sever documentation + + + + + + + + + + + + + +
+
+
+
f
+
+ renderGfm + +
No documentation available
+
+
+
+
+
+
+
+
+

Usage

import * as mod from "render_gfm.ts";
+
+
+
+
+ + diff --git a/docs/render_gfm.ts/~/renderGfm.html b/docs/render_gfm.ts/~/renderGfm.html new file mode 100644 index 0000000..d421536 --- /dev/null +++ b/docs/render_gfm.ts/~/renderGfm.html @@ -0,0 +1,264 @@ + + + + renderGfm - Portfolio Sever documentation + + + + + + + + + + + + + +
+
+
+
+ function renderGfm +
+ + + + +
+
+ +
+
+

+ + + + + + + + + + +Parameters

+ + + + + + + + + + +
+ md: string + + + + + + +
+
+
+
+

+ + + + + + + + + + +Return Type

+
+
+
+
+
+
+
+

Usage

import { renderGfm } from "render_gfm.ts";
+
+
+
+
+ + diff --git a/docs/search_index.js b/docs/search_index.js index 458bb3b..30fc6c4 100644 --- a/docs/search_index.js +++ b/docs/search_index.js @@ -1,3 +1,3 @@ (function () { - window.DENO_DOC_SEARCH_INDEX = {"nodes":[{"kind":["function"],"name":"serveFile","file":"serve_file.ts","location":{"filename":"serve_file.ts","line":4,"col":0,"byteIndex":84},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getBaseUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":146,"col":0,"byteIndex":3773},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getIndexUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":50,"col":0,"byteIndex":1404},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getRepoUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":18,"col":0,"byteIndex":459},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getSourceUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":89,"col":0,"byteIndex":2647},"declarationKind":"export","deprecated":false},{"kind":["typeAlias"],"name":"User","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":2,"col":0,"byteIndex":60},"declarationKind":"export","deprecated":false},{"kind":["typeAlias"],"name":"UserDomain","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":27,"col":0,"byteIndex":699},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"toUser","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":18,"col":0,"byteIndex":442},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"toUserDomain","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":53,"col":0,"byteIndex":1310},"declarationKind":"export","deprecated":false}]}; + window.DENO_DOC_SEARCH_INDEX = {"nodes":[{"kind":["function"],"name":"renderGfm","file":"render_gfm.ts","location":{"filename":"render_gfm.ts","line":3,"col":0,"byteIndex":52},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"serveFile","file":"serve_file.ts","location":{"filename":"serve_file.ts","line":5,"col":0,"byteIndex":128},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getBaseUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":146,"col":0,"byteIndex":3773},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getIndexUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":50,"col":0,"byteIndex":1404},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getRepoUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":18,"col":0,"byteIndex":459},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"getSourceUrl","file":"url_utils.ts","location":{"filename":"url_utils.ts","line":89,"col":0,"byteIndex":2647},"declarationKind":"export","deprecated":false},{"kind":["typeAlias"],"name":"User","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":2,"col":0,"byteIndex":60},"declarationKind":"export","deprecated":false},{"kind":["typeAlias"],"name":"UserDomain","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":27,"col":0,"byteIndex":699},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"toUser","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":18,"col":0,"byteIndex":442},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"toUserDomain","file":"user_utils.ts","location":{"filename":"user_utils.ts","line":53,"col":0,"byteIndex":1310},"declarationKind":"export","deprecated":false}]}; })() \ No newline at end of file diff --git a/docs/serve_file.ts/~/index.html b/docs/serve_file.ts/~/index.html index 3288216..a0ec29c 100644 --- a/docs/serve_file.ts/~/index.html +++ b/docs/serve_file.ts/~/index.html @@ -84,6 +84,10 @@ Functions

f
getRepoUrl -
  • -
    f
    -getSourceUrl -
    • - view all 9 symbolsview all 10 symbols./dist/index.html to return either ./di