From 6dbc7bd206d72e71142371332246f2f75077c603 Mon Sep 17 00:00:00 2001 From: ndy2 Date: Fri, 8 Mar 2024 01:02:16 +0900 Subject: [PATCH] add comment with giscus --- docs/assets/overrides/partials/comments.html | 48 ++++++++++++++++++++ docs/features/admonition/backquotes.md | 1 + docs/features/admonition/callout.md | 1 + docs/features/admonition/demo.md | 4 ++ docs/features/comment/index.md | 1 + docs/features/image-link/index.md | 1 + docs/features/pdf/index.md | 5 +- docs/features/tabs/index.md | 4 ++ docs/features/tags/index.md | 1 + docs/index.md | 1 + mkdocs.yml | 1 + 11 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 docs/assets/overrides/partials/comments.html diff --git a/docs/assets/overrides/partials/comments.html b/docs/assets/overrides/partials/comments.html new file mode 100644 index 0000000..073bf9e --- /dev/null +++ b/docs/assets/overrides/partials/comments.html @@ -0,0 +1,48 @@ +{% if page.meta.comments %} +

{{ lang.t("meta.comments") }}

+ + + + +{% endif %} \ No newline at end of file diff --git a/docs/features/admonition/backquotes.md b/docs/features/admonition/backquotes.md index 0c96907..8d0844b 100644 --- a/docs/features/admonition/backquotes.md +++ b/docs/features/admonition/backquotes.md @@ -1,5 +1,6 @@ --- title: Admonition Backquotes +comments: true --- > [!note] feature - admonition backquotes > convert `block-styled admonition` to `mkdocs-material admonition` diff --git a/docs/features/admonition/callout.md b/docs/features/admonition/callout.md index d4d3054..544086f 100644 --- a/docs/features/admonition/callout.md +++ b/docs/features/admonition/callout.md @@ -1,5 +1,6 @@ --- title: Admonition Callout +comments: true --- > [!note] feature - admonition callout > Convert `obsidian callout` to `mkdocs-material admonition` diff --git a/docs/features/admonition/demo.md b/docs/features/admonition/demo.md index a4796e5..a44262a 100644 --- a/docs/features/admonition/demo.md +++ b/docs/features/admonition/demo.md @@ -1,3 +1,7 @@ +--- +title: Demo +comments: true +--- ## Examples `1. basic` diff --git a/docs/features/comment/index.md b/docs/features/comment/index.md index 9c74325..3be70d5 100644 --- a/docs/features/comment/index.md +++ b/docs/features/comment/index.md @@ -1,5 +1,6 @@ --- title: Comment +comments: true --- > [!note] feature - comment diff --git a/docs/features/image-link/index.md b/docs/features/image-link/index.md index ddcda07..689e28a 100644 --- a/docs/features/image-link/index.md +++ b/docs/features/image-link/index.md @@ -1,5 +1,6 @@ --- title: Image-Link +comments: true --- > [!note] feature - image-link > Convert `obsidian wikilink for images` to `mkdocs-material md-link for images` diff --git a/docs/features/pdf/index.md b/docs/features/pdf/index.md index eaf255f..45d7b89 100644 --- a/docs/features/pdf/index.md +++ b/docs/features/pdf/index.md @@ -1,4 +1,7 @@ - +--- +title: Pdf +comments: true +--- > [!note] feature - image-link > Convert `obsidian embed pdf` to `html embed pdf` > diff --git a/docs/features/tabs/index.md b/docs/features/tabs/index.md index 669fa6c..bcfa035 100644 --- a/docs/features/tabs/index.md +++ b/docs/features/tabs/index.md @@ -1,3 +1,7 @@ +--- +title: Tabs +comments: true +--- > [!note] feature - tags > Convert `obsidian html-tabs` to `mkdocs-material content tab` > diff --git a/docs/features/tags/index.md b/docs/features/tags/index.md index 7258cd1..95157f8 100644 --- a/docs/features/tags/index.md +++ b/docs/features/tags/index.md @@ -1,5 +1,6 @@ --- title: Tags +comments: true --- > [!note] feature - tags > Convert `obsidian tags` to `mkdocs-material search` diff --git a/docs/index.md b/docs/index.md index 18d3c5f..4420662 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: README +comments: true --- Plugin for [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to convert semantic in documentation diff --git a/mkdocs.yml b/mkdocs.yml index ab245cf..9f26ee8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ theme: font: text: Roboto code: Roboto Mono + custom_dir: docs/assets/overrides features: - content.code.copy - content.action.view