From 47c65cd551a313beef1b0e39d697c1759f264c5e Mon Sep 17 00:00:00 2001 From: saicaca Date: Fri, 3 May 2024 01:27:42 +0800 Subject: [PATCH] docs: update example posts --- src/content/posts/guide/index.md | 2 +- src/content/posts/markdown-extended.md | 55 +++++++++++++++++++------- src/content/posts/video.md | 2 +- src/content/spec/about.md | 2 + 4 files changed, 45 insertions(+), 16 deletions(-) diff --git a/src/content/posts/guide/index.md b/src/content/posts/guide/index.md index 6895cf2..8db1e3d 100644 --- a/src/content/posts/guide/index.md +++ b/src/content/posts/guide/index.md @@ -1,6 +1,6 @@ --- title: Simple Guides for Fuwari -published: 2023-09-01 +published: 2024-04-01 description: "How to use this blog template." image: "./cover.jpeg" tags: ["Fuwari", "Blogging", "Customization"] diff --git a/src/content/posts/markdown-extended.md b/src/content/posts/markdown-extended.md index 0a54327..3e50770 100644 --- a/src/content/posts/markdown-extended.md +++ b/src/content/posts/markdown-extended.md @@ -1,39 +1,66 @@ --- -title: Markdown extended features +title: Markdown Extended Features published: 2024-05-01 description: 'Read more about Markdown features in Fuwari' image: '' tags: [Demo, Example, Markdown, Fuwari] -category: 'Examlpes' +category: 'Examples' draft: false --- -## Github repository cards -You can add dynamic cards that link to Github repositories, on page load, the repository information is pulled from the Github API. `::github{repo="saicaca/fuwari"}` +## GitHub repository cards +You can add dynamic cards that link to GitHub repositories, on page load, the repository information is pulled from the GitHub API. ::github{repo="Fabrizz/MMM-OnSpotify"} +Create a GitHub repository card with the code `::github{repo="/"}`. -## Admonitions, notes, containers -Fuwari supports admonitions of type: `tip, note, important, warning, caution` +```markdown +::github{repo="saicaca/fuwari"} +``` + +## Admonitions + +Following types of admonitions are supported: `note` `tip` `important` `warning` `caution` :::note -This is a note, other frameworks call them containers or alerts +Highlights information that users should take into account, even when skimming. ::: -:::tip{title="TIP"} -This is a tip, you can change the title using the title property: `:::tip{title="Custom title"} \` +:::tip +Optional information to help a user be more successful. ::: :::important -Drink 8 glasses of water! +Crucial information necessary for users to succeed. ::: :::warning -You should star the [Fuwari repository](https://github.com/saicaca/fuwari) +Critical content demanding immediate user attention due to potential risks. ::: :::caution -Admonitions can have other elements inside -::github{repo="saicaca/fuwari"} -::: \ No newline at end of file +Negative potential consequences of an action. +::: + +```markdown +:::note +Highlights information that users should take into account, even when skimming. +::: + +:::tip +Optional information to help a user be more successful. +::: +``` + +The title of the admonition can be customized. + +:::note[MY CUSTOM TITLE] +This is a note with a custom title. +::: + +```markdown +:::note[MY CUSTOM TITLE] +This is a note with a custom title. +::: +``` \ No newline at end of file diff --git a/src/content/posts/video.md b/src/content/posts/video.md index 4cc156e..4d53a95 100644 --- a/src/content/posts/video.md +++ b/src/content/posts/video.md @@ -1,6 +1,6 @@ --- title: Include Video in the Posts -published: 2022-08-01 +published: 2023-08-01 description: This post demonstrates how to include embedded video in a blog post. tags: [Example, Video] category: Examples diff --git a/src/content/spec/about.md b/src/content/spec/about.md index ecbb28e..40d9fe8 100644 --- a/src/content/spec/about.md +++ b/src/content/spec/about.md @@ -1,6 +1,8 @@ # About This is the demo site for [Fuwari](https://github.com/saicaca/fuwari). +::github{repo="saicaca/fuwari"} + > ### Sources of images used in this site > - [Unsplash](https://unsplash.com/) > - [星と少女](https://www.pixiv.net/artworks/108916539) by [Stella](https://www.pixiv.net/users/93273965)