The following options control the appearance of the theme. You don't need to pay attention to them in most cases, they are only provided for a small amount of users with needs.
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static site to host them.
The theme provides progressive web app support [^pwa-intro] via [@vuepress/plugin-pwa][pwa]. To use it, install @vuepress/plugin-pwa manually in your project.
\n
\n
Info
\n
If you are using this plugin, we recommend you to set shouldPrefetch: false in your VuePress config file.
\n
vuepress-theme-hope provides plugins.pwa in theme options to @vuepress/plugin-pwa.
When setting { custom: true } in Behavior options, the theme will import components through @theme-hope alias, so you can use it to replace any component of the theme.
The topic provides you with a list of all articles under the path /article/ by default.
\n
Article
\n
All articles will be added to the article list by default and rendered under the path /article/.
\n
\n
\n
If you don't want the list to contain some specific articles, just set the article to false in the frontmatter of the article, or you may customize it through plugins.blog.filter in theme options.
\n
To sticky a specific article in the article list, just set sticky to true in the frontmatter of the article.
\n
\n
Order
\n
For sticky articles, you can set sticky with a number to set their order. Articles with large numbers will be listed first.
\n
\n
Excerpt
\n
Adding Excerpt
\n
If you want to add an excerpt for an article, you can mark contents with `
You may not want some of your articles to be copied by others, or you want copyright information appended to the clipboard when copying. \nvuepress-theme-hope use [@vuepress/plugin-copyright][copyright] to provide this feature.
\n
\n
Info
\n
vuepress-theme-hope passes plugins.copyright in theme options to @vuepress/plugin-copyright.
The theme supports encryption of specific folders or specific paths, as well as global scope encryption.
\n
\n
Caution
\n
Note that because of the limitation of vuepress, the content of the article is only hidden before being decrypted, and visitors can still get the content of the article from the source code (from js).
\n
Please DO NOT USE this encryption function for any sensitive and confidential articles and files, please bear the consequences of it.
The theme displays last update time and contributors of the page via the [@vuepress/plugin-git][git] plugin, and provides support for an \"edit this page\" button.
\n
The theme also provides navigation buttons for previous and next pages depending on sidebar config.
The theme adds built-in support for , [@vuepress/plugin-docsearch][docsearch] and [@vuepress/plugin-search][search]. Just install the plugin you want and config it, you will get a search box in navbar.
The entire theme adds FontClass and Image format icon support in multiple places.
\n
You can use iconfont, iconify and fontawesome to add icons to your project, and you can also use your own icon assets. Also, png/svg format icon is supported. You can use full links or pathname to add icons.
The theme adds Breadcrumb support, you can configure it using breadcrumb in page frontmatter and theme options
\n
Without any config, a Breadcrumb that matches the theme color is displayed at the top of the page content to help the reader understand the document structure.
vuepress-theme-hope improves the default home page.
\n
To use it, set home: true in page frontmatter. Any extra content after the YAML front matter will be parsed as normal Markdown and rendered after the features section.
This version requires Vue3.4, with Vue performance improvements.
-
Uncommon plugins like copyright2, feed2, pwa2 plugins are optional in theme, so you need to install them manually to use them.
-
The theme adds built-in search config support for @vuepress/docsearch@vuepress/search and search-pro. After installing them, you only need to provide necessary options, and the theme will do the rest job for you.
-
The theme now thinks that categories and tags in frontmatter are standard, which will improve experience with tools like Obsidian.
-
md-enhance now undeprecate danger container support back to align vuepress default theme.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.js b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.js
deleted file mode 100644
index 22d3a0f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.vue"
-const data = JSON.parse("{\"path\":\"/config/frontmatter/blog-home.html\",\"title\":\"Blog Home Frontmatter Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog Home Frontmatter Config\",\"icon\":\"blog\",\"order\":5,\"category\":[\"Config\"],\"tag\":[\"Frontmatter\",\"Blog Home\"],\"description\":\"home Type: boolean Default: false Enable homepage style when setting to true title Type: string Required: No Page title, will be used in breadcrumb, seo, etc. heroText Type: str...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/frontmatter/blog-home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/frontmatter/blog-home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/frontmatter/blog-home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog Home Frontmatter Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"home Type: boolean Default: false Enable homepage style when setting to true title Type: string Required: No Page title, will be used in breadcrumb, seo, etc. heroText Type: str...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Frontmatter\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog Home\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog Home Frontmatter Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"home\",\"slug\":\"home\",\"link\":\"#home\",\"children\":[]},{\"level\":2,\"title\":\"title\",\"slug\":\"title\",\"link\":\"#title\",\"children\":[]},{\"level\":2,\"title\":\"heroText\",\"slug\":\"herotext\",\"link\":\"#herotext\",\"children\":[]},{\"level\":2,\"title\":\"tagline\",\"slug\":\"tagline\",\"link\":\"#tagline\",\"children\":[]},{\"level\":2,\"title\":\"heroImage\",\"slug\":\"heroimage\",\"link\":\"#heroimage\",\"children\":[]},{\"level\":2,\"title\":\"heroImageDark\",\"slug\":\"heroimagedark\",\"link\":\"#heroimagedark\",\"children\":[]},{\"level\":2,\"title\":\"heroImageStyle\",\"slug\":\"heroimagestyle\",\"link\":\"#heroimagestyle\",\"children\":[]},{\"level\":2,\"title\":\"heroAlt\",\"slug\":\"heroalt\",\"link\":\"#heroalt\",\"children\":[]},{\"level\":2,\"title\":\"bgImage\",\"slug\":\"bgimage\",\"link\":\"#bgimage\",\"children\":[]},{\"level\":2,\"title\":\"bgImageDark\",\"slug\":\"bgimagedark\",\"link\":\"#bgimagedark\",\"children\":[]},{\"level\":2,\"title\":\"bgImageStyle\",\"slug\":\"bgimagestyle\",\"link\":\"#bgimagestyle\",\"children\":[]},{\"level\":2,\"title\":\"heroFullScreen\",\"slug\":\"herofullscreen\",\"link\":\"#herofullscreen\",\"children\":[]},{\"level\":2,\"title\":\"projects\",\"slug\":\"projects\",\"link\":\"#projects\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.75,\"words\":225},\"filePathRelative\":\"config/frontmatter/blog-home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.vue
deleted file mode 100644
index 37aa296..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/blog-home.html.vue
+++ /dev/null
@@ -1,108 +0,0 @@
-
interface ThemeBlogHomeProjectOptions {
- /**
- * Project name
- */
- name: string;
-
- /**
- * Project description
- */
- desc?: string;
-
- /**
- * Project link
- */
- link: string;
-
- /**
- * Project icon
- *
- * @description image link or icon fontClass are supported, as well as `"link"`、`"project"`、`"book"`、`"article"`、`"friend"`
- */
- icon?: string;
-}
-
-
-
Required: No
-
-
-
Project list
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.js b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.js
deleted file mode 100644
index 0fc611b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.vue"
-const data = JSON.parse("{\"path\":\"/config/frontmatter/home.html\",\"title\":\"Home Frontmatter Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Home Frontmatter Config\",\"icon\":\"home\",\"order\":4,\"category\":[\"Config\"],\"tag\":[\"Frontmatter\",\"Home\"],\"description\":\"home Type: boolean Default: false Enable homepage style when setting to true title Type: string Required: No Page title, will be used in breadcrumb, seo, etc. heroText Type: str...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/frontmatter/home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/frontmatter/home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/frontmatter/home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Home Frontmatter Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"home Type: boolean Default: false Enable homepage style when setting to true title Type: string Required: No Page title, will be used in breadcrumb, seo, etc. heroText Type: str...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Frontmatter\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Home\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Home Frontmatter Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"home\",\"slug\":\"home\",\"link\":\"#home\",\"children\":[]},{\"level\":2,\"title\":\"title\",\"slug\":\"title\",\"link\":\"#title\",\"children\":[]},{\"level\":2,\"title\":\"heroText\",\"slug\":\"herotext\",\"link\":\"#herotext\",\"children\":[]},{\"level\":2,\"title\":\"tagline\",\"slug\":\"tagline\",\"link\":\"#tagline\",\"children\":[]},{\"level\":2,\"title\":\"heroImage\",\"slug\":\"heroimage\",\"link\":\"#heroimage\",\"children\":[]},{\"level\":2,\"title\":\"heroImageDark\",\"slug\":\"heroimagedark\",\"link\":\"#heroimagedark\",\"children\":[]},{\"level\":2,\"title\":\"heroAlt\",\"slug\":\"heroalt\",\"link\":\"#heroalt\",\"children\":[]},{\"level\":2,\"title\":\"heroImageStyle\",\"slug\":\"heroimagestyle\",\"link\":\"#heroimagestyle\",\"children\":[]},{\"level\":2,\"title\":\"bgImage\",\"slug\":\"bgimage\",\"link\":\"#bgimage\",\"children\":[]},{\"level\":2,\"title\":\"bgImageDark\",\"slug\":\"bgimagedark\",\"link\":\"#bgimagedark\",\"children\":[]},{\"level\":2,\"title\":\"bgImageStyle\",\"slug\":\"bgimagestyle\",\"link\":\"#bgimagestyle\",\"children\":[]},{\"level\":2,\"title\":\"heroFullScreen\",\"slug\":\"herofullscreen\",\"link\":\"#herofullscreen\",\"children\":[]},{\"level\":2,\"title\":\"actions\",\"slug\":\"actions\",\"link\":\"#actions\",\"children\":[]},{\"level\":2,\"title\":\"highlights\",\"slug\":\"highlights\",\"link\":\"#highlights\",\"children\":[]},{\"level\":2,\"title\":\"features\",\"slug\":\"features\",\"link\":\"#features\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.59,\"words\":476},\"filePathRelative\":\"config/frontmatter/home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.vue
deleted file mode 100644
index 5e7f931..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/home.html.vue
+++ /dev/null
@@ -1,279 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.js b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.js
deleted file mode 100644
index 761c7ce..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.vue"
-const data = JSON.parse("{\"path\":\"/config/frontmatter/info.html\",\"title\":\"Info Frontmatter Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Info Frontmatter Config\",\"icon\":\"circle-info\",\"order\":1,\"category\":[\"Config\"],\"tag\":[\"Frontmatter\",\"Info\"],\"description\":\"You can set information for page with the following frontmatter options. title Type: string Required: No Current page's title. Markdown's first h1 by default. shortTitle Type: s...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/frontmatter/info.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/frontmatter/info.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/frontmatter/info.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Info Frontmatter Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can set information for page with the following frontmatter options. title Type: string Required: No Current page's title. Markdown's first h1 by default. shortTitle Type: s...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Frontmatter\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Info\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Info Frontmatter Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"title\",\"slug\":\"title\",\"link\":\"#title\",\"children\":[]},{\"level\":2,\"title\":\"shortTitle\",\"slug\":\"shorttitle\",\"link\":\"#shorttitle\",\"children\":[]},{\"level\":2,\"title\":\"description\",\"slug\":\"description\",\"link\":\"#description\",\"children\":[]},{\"level\":2,\"title\":\"icon\",\"slug\":\"icon\",\"link\":\"#icon\",\"children\":[]},{\"level\":2,\"title\":\"author\",\"slug\":\"author\",\"link\":\"#author\",\"children\":[]},{\"level\":2,\"title\":\"isOriginal\",\"slug\":\"isoriginal\",\"link\":\"#isoriginal\",\"children\":[]},{\"level\":2,\"title\":\"date\",\"slug\":\"date\",\"link\":\"#date\",\"children\":[]},{\"level\":2,\"title\":\"category\",\"slug\":\"category\",\"link\":\"#category\",\"children\":[]},{\"level\":2,\"title\":\"tag\",\"slug\":\"tag\",\"link\":\"#tag\",\"children\":[]},{\"level\":2,\"title\":\"license\",\"slug\":\"license\",\"link\":\"#license\",\"children\":[]},{\"level\":2,\"title\":\"sticky\",\"slug\":\"sticky\",\"link\":\"#sticky\",\"children\":[]},{\"level\":2,\"title\":\"star\",\"slug\":\"star\",\"link\":\"#star\",\"children\":[]},{\"level\":2,\"title\":\"article\",\"slug\":\"article\",\"link\":\"#article\",\"children\":[]},{\"level\":2,\"title\":\"timeline\",\"slug\":\"timeline\",\"link\":\"#timeline\",\"children\":[]},{\"level\":2,\"title\":\"cover\",\"slug\":\"cover\",\"link\":\"#cover\",\"children\":[]},{\"level\":2,\"title\":\"banner\",\"slug\":\"banner\",\"link\":\"#banner\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.25,\"words\":374},\"filePathRelative\":\"config/frontmatter/info.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.vue
deleted file mode 100644
index 5d9ce87..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/info.html.vue
+++ /dev/null
@@ -1,135 +0,0 @@
-
You can set information for page with the following frontmatter options.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.js b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.js
deleted file mode 100644
index a47590b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.vue"
-const data = JSON.parse("{\"path\":\"/config/frontmatter/plugins.html\",\"title\":\"Plugin Frontmatter Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Plugin Frontmatter Config\",\"icon\":\"puzzle-piece\",\"order\":3,\"category\":[\"Config\"],\"tag\":[\"Frontmatter\",\"Layout\"],\"description\":\"You can configure the following options in the frontmatter of the page to control plugin behavior. Options for @vuepress/plugin-copyright copy.triggerLength Type: number Default...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/frontmatter/plugins.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/frontmatter/plugins.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/frontmatter/plugins.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Plugin Frontmatter Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can configure the following options in the frontmatter of the page to control plugin behavior. Options for @vuepress/plugin-copyright copy.triggerLength Type: number Default...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Frontmatter\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Plugin Frontmatter Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Options for @vuepress/plugin-copyright\",\"slug\":\"options-for-vuepress-plugin-copyright\",\"link\":\"#options-for-vuepress-plugin-copyright\",\"children\":[{\"level\":3,\"title\":\"copy.triggerLength\",\"slug\":\"copy-triggerlength\",\"link\":\"#copy-triggerlength\",\"children\":[]},{\"level\":3,\"title\":\"copy.disableCopy\",\"slug\":\"copy-disablecopy\",\"link\":\"#copy-disablecopy\",\"children\":[]},{\"level\":3,\"title\":\"copy.disableSelection\",\"slug\":\"copy-disableselection\",\"link\":\"#copy-disableselection\",\"children\":[]}]},{\"level\":2,\"title\":\"Options for @vuepress/plugin-feed\",\"slug\":\"options-for-vuepress-plugin-feed\",\"link\":\"#options-for-vuepress-plugin-feed\",\"children\":[{\"level\":3,\"title\":\"feed.title\",\"slug\":\"feed-title\",\"link\":\"#feed-title\",\"children\":[]},{\"level\":3,\"title\":\"feed.description\",\"slug\":\"feed-description\",\"link\":\"#feed-description\",\"children\":[]},{\"level\":3,\"title\":\"feed.content\",\"slug\":\"feed-content\",\"link\":\"#feed-content\",\"children\":[]},{\"level\":3,\"title\":\"feed.author\",\"slug\":\"feed-author\",\"link\":\"#feed-author\",\"children\":[]},{\"level\":3,\"title\":\"feed.contributor\",\"slug\":\"feed-contributor\",\"link\":\"#feed-contributor\",\"children\":[]},{\"level\":3,\"title\":\"feed.guid\",\"slug\":\"feed-guid\",\"link\":\"#feed-guid\",\"children\":[]}]},{\"level\":2,\"title\":\"Options for @vuepress/sitemap\",\"slug\":\"options-for-vuepress-sitemap\",\"link\":\"#options-for-vuepress-sitemap\",\"children\":[{\"level\":3,\"title\":\"sitemap.changefreq\",\"slug\":\"sitemap-changefreq\",\"link\":\"#sitemap-changefreq\",\"children\":[]},{\"level\":3,\"title\":\"sitemap.exclude\",\"slug\":\"sitemap-exclude\",\"link\":\"#sitemap-exclude\",\"children\":[]},{\"level\":3,\"title\":\"sitemap.priority\",\"slug\":\"sitemap-priority\",\"link\":\"#sitemap-priority\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.85,\"words\":254},\"filePathRelative\":\"config/frontmatter/plugins.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.vue
deleted file mode 100644
index aa452d6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/frontmatter/plugins.html.vue
+++ /dev/null
@@ -1,131 +0,0 @@
-
You can configure the following options in the frontmatter of the page to control plugin behavior.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.js b/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.js
deleted file mode 100644
index 5f626ff..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.vue"
-const data = JSON.parse("{\"path\":\"/config/i18n.html\",\"title\":\"I18n\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"I18n\",\"icon\":\"language\",\"order\":2,\"category\":[\"Config\"],\"tag\":[\"I18N\"],\"description\":\"Setting Language You need to set the lang option for each language. Even if you are only using a single language, you must set lang in .vuepress/config.{js,ts}. Why setting it? ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/i18n.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/i18n.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/i18n.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"I18n\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Setting Language You need to set the lang option for each language. Even if you are only using a single language, you must set lang in .vuepress/config.{js,ts}. Why setting it? ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"I18N\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"I18n\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Setting Language\",\"slug\":\"setting-language\",\"link\":\"#setting-language\",\"children\":[]},{\"level\":2,\"title\":\"Internationalization\",\"slug\":\"internationalization\",\"link\":\"#internationalization\",\"children\":[]},{\"level\":2,\"title\":\"Supported Languages\",\"slug\":\"supported-languages\",\"link\":\"#supported-languages\",\"children\":[]},{\"level\":2,\"title\":\"Setting Options for Each Language\",\"slug\":\"setting-options-for-each-language\",\"link\":\"#setting-options-for-each-language\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.76,\"words\":528},\"filePathRelative\":\"config/i18n.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.vue
deleted file mode 100644
index 3e80680..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/i18n.html.vue
+++ /dev/null
@@ -1,159 +0,0 @@
-
You need to set the lang option for each language. Even if you are only using a single language, you must set lang in .vuepress/config.{js,ts}.
-
-
Why setting it?
-
To provide the correct locale text, the theme needs to know which language every directory is using.
-
-
-TS Single Language
-JS Single Language
-TS Multi Language
-JS Multi Language
-
-
import { defineUserConfig } from "vuepress";
-
-export default defineUserConfig({
- // Set language you are using
- lang: "en-US",
-});
-
-
-
export default {
- // Set language you are using
- lang: "en-US",
-};
-
-
-
import { defineUserConfig } from "vuepress";
-
-export default defineUserConfig({
- locales: {
- "/": {
- // Set language you are using
- lang: "en-US",
- },
- "/zh/": {
- // Set language you are using
- lang: "zh-TW",
- },
- },
-});
-
-
-
export default {
- locales: {
- "/": {
- // Set language you are using
- lang: "en-US",
- },
- "/zh/": {
- // Set language you are using
- lang: "zh-TW",
- },
- },
-};
-
locales is an object whose key is the path prefix of each language, and value is the configuration of this language. The value object can include title, description, lang, etc.
You should set the lang option for each language so that themes and plugins can handle them correctly.
-
If the locales objects only contain the "/" key, the theme will not display the language dropdown menu. When you set multiple keys through locales (when there are multiple languages), we will display a language dropdown menu in navbar.
If you need multi-language support for other languages, you can set locales for theme and plugins, this also gives you the ability to customize built-in locales. For details, see Theme I18n Options.
-
Also submit a PR to all files named locale.ts or under locale folder in this repo is welcomed.
Like the Site Config and Theme Config of @vuepress/theme-default, vuepress-theme-hope also supports you to set a locale option in theme options, and set different config for each language.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/intro.html.js b/docs/theme/src/.vuepress/.temp/pages/config/intro.html.js
deleted file mode 100644
index c67c8f6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/intro.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/intro.html.vue"
-const data = JSON.parse("{\"path\":\"/config/intro.html\",\"title\":\"Config Intro\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Config Intro\",\"icon\":\"gears\",\"order\":1,\"category\":[\"Config\"],\"tag\":[\"Intro\"],\"description\":\"Config Concepts VuePress mainly stores config and required files through the .vuepress/ folder in the directory. Info For the file structure of VuePress, see . In VuePress, ther...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/intro.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/intro.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/intro.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Config Intro\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Config Concepts VuePress mainly stores config and required files through the .vuepress/ folder in the directory. Info For the file structure of VuePress, see . In VuePress, ther...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Config Intro\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Config Concepts\",\"slug\":\"config-concepts\",\"link\":\"#config-concepts\",\"children\":[]},{\"level\":2,\"title\":\"Theme Usage\",\"slug\":\"theme-usage\",\"link\":\"#theme-usage\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.54,\"words\":163},\"filePathRelative\":\"config/intro.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/intro.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/intro.html.vue
deleted file mode 100644
index 5c04e20..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/intro.html.vue
+++ /dev/null
@@ -1,58 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/blog.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/blog.html.js
deleted file mode 100644
index 6ba121e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/blog.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/blog.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/blog.html\",\"title\":\"Blog Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog Plugin Config\",\"icon\":\"blog\",\"order\":3,\"category\":[\"Config\"],\"tag\":[\"Blog\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme provides blog feature via @vuepress/plugin-blog, and it's not enabled by default. You can enable blog feature by setting plugins.blog to true in theme options. F...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/blog.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/blog.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/blog.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme provides blog feature via @vuepress/plugin-blog, and it's not enabled by default. You can enable blog feature by setting plugins.blog to true in theme options. F...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"Options\",\"slug\":\"options\",\"link\":\"#options\",\"children\":[{\"level\":3,\"title\":\"excerpt\",\"slug\":\"excerpt\",\"link\":\"#excerpt\",\"children\":[]},{\"level\":3,\"title\":\"excerptSeparator\",\"slug\":\"excerptseparator\",\"link\":\"#excerptseparator\",\"children\":[]},{\"level\":3,\"title\":\"excerptLength\",\"slug\":\"excerptlength\",\"link\":\"#excerptlength\",\"children\":[]},{\"level\":3,\"title\":\"filter\",\"slug\":\"filter\",\"link\":\"#filter\",\"children\":[]},{\"level\":3,\"title\":\"excerptFilter\",\"slug\":\"excerptfilter\",\"link\":\"#excerptfilter\",\"children\":[]},{\"level\":3,\"title\":\"slugify\",\"slug\":\"slugify\",\"link\":\"#slugify\",\"children\":[]},{\"level\":3,\"title\":\"type\",\"slug\":\"type\",\"link\":\"#type\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.2,\"words\":359},\"filePathRelative\":\"config/plugins/blog.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Intro
\\n
The theme provides blog feature via @vuepress/plugin-blog, and it's not enabled by default.
\\n
You can enable blog feature by setting plugins.blog to true in theme options.
interface BlogTypeOptions {
- /**
- * Unique type name
- */
- key: string;
-
- /**
- * A filter function to determine whether a page should be the type
- */
- filter: (page: Page) => boolean;
-
- /**
- * A custom function to sort the pages
- */
- sorter?: (pageA: Page, pageB: Page) => number;
-
- /**
- * Page path to be registered
- *
- * @default '/:key/'
- */
- path?: string;
-
- /**
- * Frontmatter
- */
- frontmatter?: (localePath: string) => Record<string, string>;
-
- /**
- * Layout name
- *
- * @default 'BlogType'
- */
- layout?: string;
-}
-
-
-
-- Default: `[]`
-- Details:
- - [Guide → Article List](../../guide/blog/article.md#other-types-of-articles)
-
-Additional article type.
-
-### article
-
-- Type: `string`
-- Default: `/article/`
-
-Article list route path.
-
-### category
-
-- Type: `string`
-- Default: `/category/`
-
-Category map route path.
-
-### categoryItem
-
-- Type: `string`
-- Default: `/category/:name/`
-
-Category list route path. `:name` will be replaced by category name.
-
-### tag
-
-- Type: `string`
-- Default: `/tag/`
-
-Tag map route path.
-
-### tagItem
-
-- Type: `string`
-- Default: `/tag/:name/`
-
-Tag list route path. `:name` will be replaced by tag name.
-
-### star
-
-- Type: `string`
-- Default: `/star/`
-
-Star article list route path.
-
-### timeline
-
-- Type: `string`
-- Default: `/timeline/`
-
-Timeline list route path.
-
-### hotReload
-
-- Type: `boolean`
-- Default: Whether using `--debug` flag
-
-Whether to enable hot reload in the development server.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.js
deleted file mode 100644
index f19b915..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/comment.html\",\"title\":\"Comment Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Comment Plugin Config\",\"icon\":\"comment-dots\",\"order\":4,\"category\":[\"Config\"],\"tag\":[\"Comment\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme provide comment support using @vuepress/plugin-comment, and it passes plugins.comment in theme options to the plugin. @vuepress/plugin-comment currently supports...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/comment.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/comment.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/comment.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Comment Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme provide comment support using @vuepress/plugin-comment, and it passes plugins.comment in theme options to the plugin. @vuepress/plugin-comment currently supports...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Comment\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Comment Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"Options\",\"slug\":\"options\",\"link\":\"#options\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.26,\"words\":79},\"filePathRelative\":\"config/plugins/comment.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.vue
deleted file mode 100644
index f74c946..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/comment.html.vue
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.js
deleted file mode 100644
index a508828..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/copyright.html\",\"title\":\"Copyright Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Copyright Plugin Config\",\"icon\":\"copyright\",\"order\":6,\"category\":[\"Config\"],\"tag\":[\"Copyright\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme can append copyright information while copying via @vuepress/plugin-copyright, and it's not enabled by default. You can enabled this feature by setting plugins.c...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/copyright.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/copyright.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/copyright.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Copyright Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme can append copyright information while copying via @vuepress/plugin-copyright, and it's not enabled by default. You can enabled this feature by setting plugins.c...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Copyright\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Copyright Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"Plugin Options\",\"slug\":\"plugin-options\",\"link\":\"#plugin-options\",\"children\":[{\"level\":3,\"title\":\"triggerLength\",\"slug\":\"triggerlength\",\"link\":\"#triggerlength\",\"children\":[]},{\"level\":3,\"title\":\"global\",\"slug\":\"global\",\"link\":\"#global\",\"children\":[]},{\"level\":3,\"title\":\"disableCopy\",\"slug\":\"disablecopy\",\"link\":\"#disablecopy\",\"children\":[]},{\"level\":3,\"title\":\"disableSelection\",\"slug\":\"disableselection\",\"link\":\"#disableselection\",\"children\":[]},{\"level\":3,\"title\":\"canonical\",\"slug\":\"canonical\",\"link\":\"#canonical\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.53,\"words\":159},\"filePathRelative\":\"config/plugins/copyright.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.vue
deleted file mode 100644
index 815a71a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/copyright.html.vue
+++ /dev/null
@@ -1,44 +0,0 @@
-
The theme can append copyright information while copying via @vuepress/plugin-copyright, and it's not enabled by default.
-
You can enabled this feature by setting plugins.copyright to true in theme options. The default behavior globally enables the plugin and use author and license defined in theme options.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.js
deleted file mode 100644
index a6e8f95..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/feed.html\",\"title\":\"Feed Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Feed Plugin Config\",\"icon\":\"rss\",\"order\":8,\"category\":[\"Config\"],\"tag\":[\"Feed\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme can generate feeds via @vuepress/plugin-feed, and you need to manually install the plugin before using. You can enable this feature by setting plugins.feed to tr...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/feed.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/feed.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/feed.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Feed Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme can generate feeds via @vuepress/plugin-feed, and you need to manually install the plugin before using. You can enable this feature by setting plugins.feed to tr...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feed\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Feed Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"Plugin Options\",\"slug\":\"plugin-options\",\"link\":\"#plugin-options\",\"children\":[{\"level\":3,\"title\":\"atom\",\"slug\":\"atom\",\"link\":\"#atom\",\"children\":[]},{\"level\":3,\"title\":\"json\",\"slug\":\"json\",\"link\":\"#json\",\"children\":[]},{\"level\":3,\"title\":\"rss\",\"slug\":\"rss\",\"link\":\"#rss\",\"children\":[]},{\"level\":3,\"title\":\"count\",\"slug\":\"count\",\"link\":\"#count\",\"children\":[]},{\"level\":3,\"title\":\"filter\",\"slug\":\"filter\",\"link\":\"#filter\",\"children\":[]},{\"level\":3,\"title\":\"sort\",\"slug\":\"sort\",\"link\":\"#sort\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.76,\"words\":229},\"filePathRelative\":\"config/plugins/feed.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.vue
deleted file mode 100644
index da75211..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/feed.html.vue
+++ /dev/null
@@ -1,60 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.js
deleted file mode 100644
index 7701cd5..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/\",\"title\":\"Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Plugin Config\",\"icon\":\"puzzle-piece\",\"dir\":{\"order\":4},\"description\":\"Use theme plugins through theme The theme has some plugins built-in and enables them for you to enhance your experience, you should customize these plugins through theme options...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Use theme plugins through theme The theme has some plugins built-in and enables them for you to enhance your experience, you should customize these plugins through theme options...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.21,\"words\":63},\"filePathRelative\":\"config/plugins/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.vue
deleted file mode 100644
index 0a7ee1b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/index.html.vue
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
Use theme plugins through theme
-
The theme has some plugins built-in and enables them for you to enhance your experience, you should customize these plugins through theme options.
-
Some plugins are required for the theme to work properly, which means you are not allowed to call them with options yourself.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/intro.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/intro.html.js
deleted file mode 100644
index 2da08f3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/intro.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/intro.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/intro.html\",\"title\":\"Theme Plugins\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Plugins\",\"icon\":\"circle-info\",\"order\":1,\"category\":[\"Config\"],\"tag\":[\"Intro\",\"Plugin Config\",\"Theme Config\"],\"description\":\"vuepress-theme-hope bundles many VuePress plugins and adds support for more VuePress plugin.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/intro.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/intro.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/intro.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Plugins\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope bundles many VuePress plugins and adds support for more VuePress plugin.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Plugins\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Plugin Options\",\"slug\":\"plugin-options\",\"link\":\"#plugin-options\",\"children\":[]},{\"level\":2,\"title\":\"Plugin List\",\"slug\":\"plugin-list\",\"link\":\"#plugin-list\",\"children\":[{\"level\":3,\"title\":\"Internal Plugins\",\"slug\":\"internal-plugins\",\"link\":\"#internal-plugins\",\"children\":[]},{\"level\":3,\"title\":\"Automatically Enabled Plugins\",\"slug\":\"automatically-enabled-plugins\",\"link\":\"#automatically-enabled-plugins\",\"children\":[]},{\"level\":3,\"title\":\"Plugins that need to be enabled manually\",\"slug\":\"plugins-that-need-to-be-enabled-manually\",\"link\":\"#plugins-that-need-to-be-enabled-manually\",\"children\":[]},{\"level\":3,\"title\":\"Plugins with Built-in Support\",\"slug\":\"plugins-with-built-in-support\",\"link\":\"#plugins-with-built-in-support\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.6,\"words\":479},\"filePathRelative\":\"config/plugins/intro.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope bundles many VuePress plugins and adds support for more VuePress plugin.
-vuepress-plugin-search-pro: Professional Client search plugin
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.js
deleted file mode 100644
index 4c16eae..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/md-enhance.html\",\"title\":\"MdEnhance Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"MdEnhance Plugin Config\",\"icon\":\"fab fa-markdown\",\"order\":2,\"category\":[\"Config\"],\"tag\":[\"Markdown\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme can enhance Markdown syntax via vuepress-plugin-md-enhance, and by default, the theme will enable linkCheck and hint feature. You can set the following options w...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/md-enhance.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/md-enhance.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/md-enhance.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"MdEnhance Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme can enhance Markdown syntax via vuepress-plugin-md-enhance, and by default, the theme will enable linkCheck and hint feature. You can set the following options w...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"MdEnhance Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"Plugin Options\",\"slug\":\"plugin-options\",\"link\":\"#plugin-options\",\"children\":[{\"level\":3,\"title\":\"gfm\",\"slug\":\"gfm\",\"link\":\"#gfm\",\"children\":[]},{\"level\":3,\"title\":\"hint\",\"slug\":\"hint\",\"link\":\"#hint\",\"children\":[]},{\"level\":3,\"title\":\"vPre\",\"slug\":\"vpre\",\"link\":\"#vpre\",\"children\":[]},{\"level\":3,\"title\":\"breaks\",\"slug\":\"breaks\",\"link\":\"#breaks\",\"children\":[]},{\"level\":3,\"title\":\"linkify\",\"slug\":\"linkify\",\"link\":\"#linkify\",\"children\":[]},{\"level\":3,\"title\":\"alert\",\"slug\":\"alert\",\"link\":\"#alert\",\"children\":[]},{\"level\":3,\"title\":\"tabs\",\"slug\":\"tabs\",\"link\":\"#tabs\",\"children\":[]},{\"level\":3,\"title\":\"codetabs\",\"slug\":\"codetabs\",\"link\":\"#codetabs\",\"children\":[]},{\"level\":3,\"title\":\"align\",\"slug\":\"align\",\"link\":\"#align\",\"children\":[]},{\"level\":3,\"title\":\"attrs\",\"slug\":\"attrs\",\"link\":\"#attrs\",\"children\":[]},{\"level\":3,\"title\":\"sup\",\"slug\":\"sup\",\"link\":\"#sup\",\"children\":[]},{\"level\":3,\"title\":\"sub\",\"slug\":\"sub\",\"link\":\"#sub\",\"children\":[]},{\"level\":3,\"title\":\"footnote\",\"slug\":\"footnote\",\"link\":\"#footnote\",\"children\":[]},{\"level\":3,\"title\":\"mark\",\"slug\":\"mark\",\"link\":\"#mark\",\"children\":[]},{\"level\":3,\"title\":\"figure\",\"slug\":\"figure\",\"link\":\"#figure\",\"children\":[]},{\"level\":3,\"title\":\"imgLazyload\",\"slug\":\"imglazyload\",\"link\":\"#imglazyload\",\"children\":[]},{\"level\":3,\"title\":\"imgMark\",\"slug\":\"imgmark\",\"link\":\"#imgmark\",\"children\":[]},{\"level\":3,\"title\":\"imgSize\",\"slug\":\"imgsize\",\"link\":\"#imgsize\",\"children\":[]},{\"level\":3,\"title\":\"obsidianImgSize\",\"slug\":\"obsidianimgsize\",\"link\":\"#obsidianimgsize\",\"children\":[]},{\"level\":3,\"title\":\"tasklist\",\"slug\":\"tasklist\",\"link\":\"#tasklist\",\"children\":[]},{\"level\":3,\"title\":\"katex\",\"slug\":\"katex\",\"link\":\"#katex\",\"children\":[]},{\"level\":3,\"title\":\"mathjax\",\"slug\":\"mathjax\",\"link\":\"#mathjax\",\"children\":[]},{\"level\":3,\"title\":\"include\",\"slug\":\"include\",\"link\":\"#include\",\"children\":[]},{\"level\":3,\"title\":\"component\",\"slug\":\"component\",\"link\":\"#component\",\"children\":[]},{\"level\":3,\"title\":\"chart\",\"slug\":\"chart\",\"link\":\"#chart\",\"children\":[]},{\"level\":3,\"title\":\"echarts\",\"slug\":\"echarts\",\"link\":\"#echarts\",\"children\":[]},{\"level\":3,\"title\":\"flowchart\",\"slug\":\"flowchart\",\"link\":\"#flowchart\",\"children\":[]},{\"level\":3,\"title\":\"mermaid\",\"slug\":\"mermaid\",\"link\":\"#mermaid\",\"children\":[]},{\"level\":3,\"title\":\"plantuml\",\"slug\":\"plantuml\",\"link\":\"#plantuml\",\"children\":[]},{\"level\":3,\"title\":\"spoiler\",\"slug\":\"spoiler\",\"link\":\"#spoiler\",\"children\":[]},{\"level\":3,\"title\":\"stylize\",\"slug\":\"stylize\",\"link\":\"#stylize\",\"children\":[]},{\"level\":3,\"title\":\"playground\",\"slug\":\"playground\",\"link\":\"#playground\",\"children\":[]},{\"level\":3,\"title\":\"vuePlayground\",\"slug\":\"vueplayground\",\"link\":\"#vueplayground\",\"children\":[]},{\"level\":3,\"title\":\"sandpack\",\"slug\":\"sandpack\",\"link\":\"#sandpack\",\"children\":[]},{\"level\":3,\"title\":\"demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]},{\"level\":3,\"title\":\"revealJs\",\"slug\":\"revealjs\",\"link\":\"#revealjs\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.89,\"words\":1166},\"filePathRelative\":\"config/plugins/md-enhance.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.vue
deleted file mode 100644
index b981975..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/md-enhance.html.vue
+++ /dev/null
@@ -1,584 +0,0 @@
-
Honestly, we do not 100% implement GFM, we only supply its common syntax.
-
Some of the behavior might be different, for example to support Vue syntax, we are not disallowing <script> tags. But in most situation, the behavior should be same.
Whether to enable slides support. You can pass an option to control plugins and themes to import.
-
-
Info
-
Check md-enhance plugin documentation for all available options.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.js
deleted file mode 100644
index 24a9678..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/others.html\",\"title\":\"Other Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Other Plugin Config\",\"icon\":\"ellipsis\",\"order\":-1,\"category\":[\"Config\"],\"tag\":[\"Plugin Config\",\"Theme Config\"],\"description\":\"catalog Controls @vuepress/plugin-catalog which provides catalog pages generation. No extra config is required by default. Se it to false if you don't need it. Check catalog plu...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/others.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/others.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/others.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Other Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"catalog Controls @vuepress/plugin-catalog which provides catalog pages generation. No extra config is required by default. Se it to false if you don't need it. Check catalog plu...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Other Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"catalog\",\"slug\":\"catalog\",\"link\":\"#catalog\",\"children\":[]},{\"level\":2,\"title\":\"backToTop\",\"slug\":\"backtotop\",\"link\":\"#backtotop\",\"children\":[]},{\"level\":2,\"title\":\"components\",\"slug\":\"components\",\"link\":\"#components\",\"children\":[]},{\"level\":2,\"title\":\"copyCode\",\"slug\":\"copycode\",\"link\":\"#copycode\",\"children\":[]},{\"level\":2,\"title\":\"externalLinkIcon\",\"slug\":\"externallinkicon\",\"link\":\"#externallinkicon\",\"children\":[]},{\"level\":2,\"title\":\"git\",\"slug\":\"git\",\"link\":\"#git\",\"children\":[]},{\"level\":2,\"title\":\"linksCheck\",\"slug\":\"linkscheck\",\"link\":\"#linkscheck\",\"children\":[]},{\"level\":2,\"title\":\"nprogress\",\"slug\":\"nprogress\",\"link\":\"#nprogress\",\"children\":[]},{\"level\":2,\"title\":\"prismjs\",\"slug\":\"prismjs\",\"link\":\"#prismjs\",\"children\":[{\"level\":3,\"title\":\"prismjs.light\",\"slug\":\"prismjs-light\",\"link\":\"#prismjs-light\",\"children\":[]},{\"level\":3,\"title\":\"prismjs.dark\",\"slug\":\"prismjs-dark\",\"link\":\"#prismjs-dark\",\"children\":[]}]},{\"level\":2,\"title\":\"photoSwipe\",\"slug\":\"photoswipe\",\"link\":\"#photoswipe\",\"children\":[]},{\"level\":2,\"title\":\"pwa\",\"slug\":\"pwa\",\"link\":\"#pwa\",\"children\":[]},{\"level\":2,\"title\":\"readingTime\",\"slug\":\"readingtime\",\"link\":\"#readingtime\",\"children\":[{\"level\":3,\"title\":\"readingTime.wordPerMinute\",\"slug\":\"readingtime-wordperminute\",\"link\":\"#readingtime-wordperminute\",\"children\":[]}]},{\"level\":2,\"title\":\"seo\",\"slug\":\"seo\",\"link\":\"#seo\",\"children\":[]},{\"level\":2,\"title\":\"sitemap\",\"slug\":\"sitemap\",\"link\":\"#sitemap\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.36,\"words\":708},\"filePathRelative\":\"config/plugins/others.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.vue
deleted file mode 100644
index c748fe0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/others.html.vue
+++ /dev/null
@@ -1,90 +0,0 @@
-
Controls @vuepress/plugin-git which provides page meta via Git.
-
The plugin is only enabled in build mode by default to improve devServer performance. You can manually set a boolean to control the plugin state, or provide plugin options.
Controls @vuepress/plugin-links-check which provides markdown links check. You can manually set a boolean to control the plugin state, or provide plugin options.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.js b/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.js
deleted file mode 100644
index a6b5156..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.vue"
-const data = JSON.parse("{\"path\":\"/config/plugins/search.html\",\"title\":\"Search Plugin Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Search Plugin Config\",\"icon\":\"search\",\"order\":5,\"category\":[\"Config\"],\"tag\":[\"Search\",\"Plugin Config\",\"Theme Config\"],\"description\":\"Intro The theme adds built-in support for the following three plugins: @vuepress/plugin-docsearch vuepress-plugin-search-pro @vuepress/plugin-search Only 1 of the 3 can be enabl...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/plugins/search.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/plugins/search.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/plugins/search.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Search Plugin Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Intro The theme adds built-in support for the following three plugins: @vuepress/plugin-docsearch vuepress-plugin-search-pro @vuepress/plugin-search Only 1 of the 3 can be enabl...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Search\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Search Plugin Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"plugins.docsearch\",\"slug\":\"plugins-docsearch\",\"link\":\"#plugins-docsearch\",\"children\":[]},{\"level\":2,\"title\":\"plugins.searchPro\",\"slug\":\"plugins-searchpro\",\"link\":\"#plugins-searchpro\",\"children\":[]},{\"level\":2,\"title\":\"plugins.search\",\"slug\":\"plugins-search\",\"link\":\"#plugins-search\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.58,\"words\":173},\"filePathRelative\":\"config/plugins/search.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.vue
deleted file mode 100644
index 5e2f59a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/plugins/search.html.vue
+++ /dev/null
@@ -1,31 +0,0 @@
-
You need to install @vuepress/plugin-search manually.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/style.html.js b/docs/theme/src/.vuepress/.temp/pages/config/style.html.js
deleted file mode 100644
index 8000fab..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/style.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/style.html.vue"
-const data = JSON.parse("{\"path\":\"/config/style.html\",\"title\":\"Style config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Style config\",\"icon\":\"wand-magic-sparkles\",\"order\":6,\"category\":[\"Config\"],\"tag\":[\"Theme Config\",\"Style\"],\"description\":\"You can change the theme's styles in .vuepress/styles by setting variable values in the config.scss and palette.scss files. Also, you can add your own styles in .vuepress/styles...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/style.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/style.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/style.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Style config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can change the theme's styles in .vuepress/styles by setting variable values in the config.scss and palette.scss files. Also, you can add your own styles in .vuepress/styles...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Style\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Style config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"config.scss\",\"slug\":\"config-scss\",\"link\":\"#config-scss\",\"children\":[]},{\"level\":2,\"title\":\"palette.scss\",\"slug\":\"palette-scss\",\"link\":\"#palette-scss\",\"children\":[{\"level\":3,\"title\":\"Color Config\",\"slug\":\"color-config\",\"link\":\"#color-config\",\"children\":[]},{\"level\":3,\"title\":\"Layout Config\",\"slug\":\"layout-config\",\"link\":\"#layout-config\",\"children\":[]}]},{\"level\":2,\"title\":\"index.scss\",\"slug\":\"index-scss\",\"link\":\"#index-scss\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.69,\"words\":508},\"filePathRelative\":\"config/style.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
You can change the theme's styles in .vuepress/styles by setting variable values in the config.scss and palette.scss files.
\\n
Also, you can add your own styles in .vuepress/styles/index.scss.
For all colors, if they are the same in light mode and dark mode, you can set them directly; otherwise, please set a Sass variable of type Map to give the color values in light and dark modes respectively.
-
Available color variables:
-
-
$theme-color: theme color
-
$text-color: text color
-
$bg-color: background color
-
$bg-color-secondary: another "light" background color
-
$bg-color-tertiary: another "lighter" background color
-
$border-color: border color
-
$box-shadow: shadow color using on elements
-
$card-shadow: shadow color using on cards
-
-Demo
-
// set theme color to red
-$theme-color: red;
-
-// setting border color with a darker value
-$border-color: (
- light: #ddd,
- dark: #444,
-);
-
Everything filling in this will be parsed to standard CSS and then injected after theme and plugins styles.
-
So you can add new styles or override styles here:
-Demo
-
// make site name in navbar italic
-.site-name {
- font-style: italic;
-}
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/theme/appearance.html.js b/docs/theme/src/.vuepress/.temp/pages/config/theme/appearance.html.js
deleted file mode 100644
index 0e442c6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/theme/appearance.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/theme/appearance.html.vue"
-const data = JSON.parse("{\"path\":\"/config/theme/appearance.html\",\"title\":\"Theme Appearance Options\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Appearance Options\",\"icon\":\"palette\",\"order\":5,\"category\":[\"Config\"],\"tag\":[\"Theme Config\",\"Appearance\"],\"description\":\"The following options control the appearance of the theme. You don't need to pay attention to them in most cases, they are only provided for a small amount of users with needs.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/theme/appearance.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/theme/appearance.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/theme/appearance.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Appearance Options\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The following options control the appearance of the theme. You don't need to pay attention to them in most cases, they are only provided for a small amount of users with needs.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Appearance\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Appearance Options\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"iconAssets\",\"slug\":\"iconassets\",\"link\":\"#iconassets\",\"children\":[]},{\"level\":2,\"title\":\"darkmode\",\"slug\":\"darkmode\",\"link\":\"#darkmode\",\"children\":[]},{\"level\":2,\"title\":\"fullscreen\",\"slug\":\"fullscreen\",\"link\":\"#fullscreen\",\"children\":[]},{\"level\":2,\"title\":\"pure\",\"slug\":\"pure\",\"link\":\"#pure\",\"children\":[]},{\"level\":2,\"title\":\"print\",\"slug\":\"print\",\"link\":\"#print\",\"children\":[]},{\"level\":2,\"title\":\"iconPrefix\",\"slug\":\"iconprefix\",\"link\":\"#iconprefix\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.08,\"words\":324},\"filePathRelative\":\"config/theme/appearance.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The following options control the appearance of the theme. You don't need to pay attention to them in most cases, they are only provided for a small amount of users with needs.
The following options control the appearance of the theme. You don't need to pay attention to them in most cases, they are only provided for a small amount of users with needs.
-
-
-
Warning
-
These options are only valid when setting directly under the theme options, setting them in each language as no effect.
Prefix of icon FontClass, usually, it can be automatically set by the theme.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/theme/basic.html.js b/docs/theme/src/.vuepress/.temp/pages/config/theme/basic.html.js
deleted file mode 100644
index c958c68..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/theme/basic.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/theme/basic.html.vue"
-const data = JSON.parse("{\"path\":\"/config/theme/basic.html\",\"title\":\"Theme Basic Options\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Basic Options\",\"icon\":\"circle-info\",\"order\":2,\"category\":[\"Config\"],\"tag\":[\"Basic\",\"ThemeConfig\"],\"description\":\"Caution These options are important and require you to configure them correctly.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/theme/basic.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/theme/basic.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/theme/basic.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Basic Options\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Caution These options are important and require you to configure them correctly.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Basic\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"ThemeConfig\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Basic Options\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"hostname\",\"slug\":\"hostname\",\"link\":\"#hostname\",\"children\":[]},{\"level\":2,\"title\":\"author\",\"slug\":\"author\",\"link\":\"#author\",\"children\":[]},{\"level\":2,\"title\":\"license\",\"slug\":\"license\",\"link\":\"#license\",\"children\":[]},{\"level\":2,\"title\":\"favicon\",\"slug\":\"favicon\",\"link\":\"#favicon\",\"children\":[]},{\"level\":2,\"title\":\"navbar\",\"slug\":\"navbar\",\"link\":\"#navbar\",\"children\":[]},{\"level\":2,\"title\":\"sidebar\",\"slug\":\"sidebar\",\"link\":\"#sidebar\",\"children\":[]},{\"level\":2,\"title\":\"locales\",\"slug\":\"locales\",\"link\":\"#locales\",\"children\":[]},{\"level\":2,\"title\":\"extraLocales\",\"slug\":\"extralocales\",\"link\":\"#extralocales\",\"children\":[]},{\"level\":2,\"title\":\"hotReload\",\"slug\":\"hotreload\",\"link\":\"#hotreload\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.7,\"words\":811},\"filePathRelative\":\"config/theme/basic.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
\\n
Caution
\\n
These options are important and require you to configure them correctly.
changes in markdown can take effect fast on the devServer, and avoid restarting the entire VuePress application.
-
-
In order to achieve this expectation, the theme needs to skip some time-consuming operations on the devServer, and it needs to skip some time-consuming functions that are triggered by page modifications on the devServer to improve the speed of project startup and hot update. At the same time, because some modifications will change the underlying raw data of VuePress, these modifications will cause the web page refresh and reload the entire VuePress application. In order to avoid frequent page reloads (i.e.: Page refresh is triggered, and you are getting a blank screen for a few seconds) when modifying Markdown, the theme disables some features on the devServer.
-
By default, devServer has the following limitations:
-
-
Git-based features will not be enabled, including contributors, automatic creating date and last update time (Calling Git binary and making file IO causes high time consumption)
-
The structured sidebar will only be generated when the application starts, and will not be updated subsequently (Sidebar sorting and indexing depends on every page frontmatter, any change in Markdown content will trigger recalculation, so large number of pages will result high time consumption)
-
Blog articles, tags, categories and lists of articles in each category will not be updated with the devServer (Any change in Markdown content will trigger recalculation, so large number of pages will result high time consumption)
-
ReadingTime and Word Info in blog article information are not injected (Any change in Markdown content will change the page word count information, so a VuePress underlying raw data is updated causing page refresh)
-
-
Enabling it means you accept that every modification will trigger some expensive recalculations and the whole application will restart, which usually results refreshing the page and a few seconds of blank screen in environments with weak performance.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/theme/behavior.html.js b/docs/theme/src/.vuepress/.temp/pages/config/theme/behavior.html.js
deleted file mode 100644
index c9f2785..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/theme/behavior.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/theme/behavior.html.vue"
-const data = JSON.parse("{\"path\":\"/config/theme/behavior.html\",\"title\":\"Theme Behavior Options\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Behavior Options\",\"icon\":\"circle-info\",\"order\":-1,\"category\":[\"Config\"],\"tag\":[\"Behavior Options\"],\"description\":\"hopeTheme() accepts an optional second argument, which is the behavior option. The behavior option controls the behavior of the theme. The behavior option can also accept a bool...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/theme/behavior.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/theme/behavior.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/theme/behavior.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Behavior Options\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"hopeTheme() accepts an optional second argument, which is the behavior option. The behavior option controls the behavior of the theme. The behavior option can also accept a bool...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Behavior Options\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Behavior Options\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"check\",\"slug\":\"check\",\"link\":\"#check\",\"children\":[]},{\"level\":2,\"title\":\"compact\",\"slug\":\"compact\",\"link\":\"#compact\",\"children\":[]},{\"level\":2,\"title\":\"custom\",\"slug\":\"custom\",\"link\":\"#custom\",\"children\":[]},{\"level\":2,\"title\":\"debug\",\"slug\":\"debug\",\"link\":\"#debug\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.1,\"words\":329},\"filePathRelative\":\"config/theme/behavior.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
hopeTheme() accepts an optional second argument, which is the behavior option. The behavior option controls the behavior of the theme.
\\n
The behavior option can also accept a boolean value:
Whether enable customization support by importing components through alias.
-
By default, the theme will run on performance mode, which all files are bundled and imported directly.
-
If you want to customize theme by overriding components and layouts, set this option to true and the theme will load components and layouts with @theme-hope alias.
The encryption configuration is an object with a key name matching the path and a key-value corresponding to a password that accepts a string or an array of strings.
-Example
-
{
- // This will encrypt the entire guide directory and both passwords will be available
- "/guide/": ["1234", "5678"],
- // this will only encrypt /config/page.html
- "/config/page.html": "1234"
-}
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.js b/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.js
deleted file mode 100644
index 046c1d4..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.vue"
-const data = JSON.parse("{\"path\":\"/config/theme/i18n.html\",\"title\":\"Theme I18n Options\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme I18n Options\",\"icon\":\"language\",\"order\":6,\"category\":[\"Config\"],\"tag\":[\"I18n\",\"Theme Config\"],\"description\":\"You can add the following options to locales[localePath] in theme options to customize the theme's multilingual options. Meanwhile, some i18n options are controlled by plugins, ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/config/theme/i18n.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/config/theme/i18n.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/config/theme/i18n.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme I18n Options\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can add the following options to locales[localePath] in theme options to customize the theme's multilingual options. Meanwhile, some i18n options are controlled by plugins, ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"I18n\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme I18n Options\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.71,\"words\":512},\"filePathRelative\":\"config/theme/i18n.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.vue b/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.vue
deleted file mode 100644
index fe0c8fd..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/config/theme/i18n.html.vue
+++ /dev/null
@@ -1,257 +0,0 @@
-
You can add the following options to locales[localePath] in theme options to customize the theme's multilingual options.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/contribution.html.js b/docs/theme/src/.vuepress/.temp/pages/contribution.html.js
deleted file mode 100644
index 8d5019b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/contribution.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/contribution.html.vue"
-const data = JSON.parse("{\"path\":\"/contribution.html\",\"title\":\"Contribution Guide\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Contribution Guide\",\"icon\":\"lightbulb\",\"category\":[\"FAQ\"],\"description\":\"We always welcome everyone to contribute! Here is a guide for you.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/contribution.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/contribution.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/contribution.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Contribution Guide\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"We always welcome everyone to contribute! Here is a guide for you.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Contribution Guide\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Clone and Install Project\",\"slug\":\"clone-and-install-project\",\"link\":\"#clone-and-install-project\",\"children\":[]},{\"level\":2,\"title\":\"Project File Structure\",\"slug\":\"project-file-structure\",\"link\":\"#project-file-structure\",\"children\":[]},{\"level\":2,\"title\":\"Document Modification\",\"slug\":\"document-modification\",\"link\":\"#document-modification\",\"children\":[]},{\"level\":2,\"title\":\"Project Modification\",\"slug\":\"project-modification\",\"link\":\"#project-modification\",\"children\":[]},{\"level\":2,\"title\":\"Project Development\",\"slug\":\"project-development\",\"link\":\"#project-development\",\"children\":[]},{\"level\":2,\"title\":\"Commit\",\"slug\":\"commit\",\"link\":\"#commit\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.27,\"words\":680},\"filePathRelative\":\"contribution.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
We always welcome everyone to contribute! Here is a guide for you.
VuePress is running both in client side and node side. Node side has node module like fs, while client side is running in browser which has documentwindowsnavigator etc. globals, you should be aware of where a piece of code is running.
-
-
client directory stores code running in browser
-
node directory stores code running in Node.js
-
shared directory stores files that are used in both client and node, so code shall not reference any browser globals or node module.
-
-
For better performance, all plugins are packed and minified using rollup when they are published.
The project uses husky to add Git Hooks for verification:
-
-
-
In precommit stage: we use lint-staged to check the changed code with the corresponding Linter
-
This means that you need to ensure that your code is formatted by the project requirements and can pass Linter tests.
-
-
-
In commit-msg stage: we use commitlint to verify the commit comment.
-
This means that you need to ensure that your commit comments comply with Semantic
-
-
-
-
Tips
-
If you cannot pass the above Git Hooks, you will not be able to complete git commit.
-
If you have already contributed something, but cannot make a commit and don't know how to fix it, you can add the --no-verify flag when committing to bypass Git Hooks.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.js
deleted file mode 100644
index 68eb171..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/\",\"title\":\"Cookbook\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Cookbook\",\"icon\":\"signs-post\",\"article\":false,\"index\":false,\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Cookbook\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"website\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"WebPage\\\",\\\"name\\\":\\\"Cookbook\\\"}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.04,\"words\":11},\"filePathRelative\":\"cookbook/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\"}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.vue
deleted file mode 100644
index c6d50c0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/index.html.vue
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.js
deleted file mode 100644
index ca6217a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/markdown/demo.html\",\"title\":\"Markdown DEMO\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Markdown DEMO\",\"icon\":\"fab fa-markdown\",\"order\":2,\"category\":[\"Cookbook\",\"Markdown\"],\"tag\":[\"Demo\",\"Markdown\"],\"description\":\"Tips For more see\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/markdown/demo.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/markdown/demo.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/markdown/demo.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Markdown DEMO\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Tips For more see\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:image\",\"content\":\"https://vuepress-theme-hope.github.io/v2/logo.png\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Demo\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Markdown DEMO\\\",\\\"image\\\":[\\\"https://vuepress-theme-hope.github.io/v2/logo.png\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1,\"words\":299},\"filePathRelative\":\"cookbook/markdown/demo.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.vue
deleted file mode 100644
index 5a2582f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/demo.html.vue
+++ /dev/null
@@ -1,297 +0,0 @@
-
This sentence has bold, italic and delete style text.
-
-
-
This sentence has **bold**, _italic_ and ~~delete~~ style text.
-
-
-
-
-
This is a paragraph.
-
This is another paragraph.
-
-
-
This is a paragraph.
-
-This is another paragraph.
-
-
-
-
-
I would like to line break at
-this point or
-this point
-
-
-
I would like to line break at
-this point or\
-this point
-
-
-
-
-
-
Blockquotes can also be nested...
-
-
...by using greater-than signs right next to each other...
-
-
...or with spaces between arrows.
-
-
-
-
-
-
> Blockquotes can also be nested...
->
-> > ...by using greater-than signs right next to each other...
-> >
-> > > ...or with spaces between arrows.
-
-
-
-
-
-
-
Create a list by starting a line with -
-
-
-
Make sub-lists by indenting 2 spaces:
-
-
-
Marker character change forces new list start:
-
-
-
Ac tristique libero volutpat at
-
-
-
Facilisis in pretium nisl aliquet
-
-
-
Nulla volutpat aliquam velit
-link break
-
New paragraph
-
-
-
-
-
-
-
It's easy!
-
-
-
-
-
- Create a list by starting a line with `-`
-- Make sub-lists by indenting 2 spaces:
-
- - Marker character change forces new list start:
-
- - Ac tristique libero volutpat at
- - Facilisis in pretium nisl aliquet
- - Nulla volutpat aliquam velit
- link break
-
- New paragraph
-
-- It's easy!
-
-
-
-
-
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-line break
-line break again
-
Integer molestie lorem at massa
-
-
-
-
1. Lorem ipsum dolor sit amet
-1. Consectetur adipiscing elit
- line break\
- line break again
-1. Integer molestie lorem at massa
-
| center | right | left |
-| :------------------------: | -----------------------: | :---------------------- |
-| For center align use `:-:` | For right align use `-:` | For left align use `:-` |
-| b | aaaaaaaaa | aaaa |
-| c | aaaa | a |
-
-
-
-
-
Inline Code: code
-
Indented code:
-
// Some comments
-line 1 of code
-line 2 of code
-line 3 of code
-
-
Block code:
-
Sample text here...
-
Syntax highlighting:
-
var foo = function (bar) {
- return bar++;
-};
-
-console.log(foo(5));
-
-
-
Inline Code: `code`
-
-Indented code:
-
- // Some comments
- line 1 of code
- line 2 of code
- line 3 of code
-
-Block code:
-
-```
-Sample text here...
-```
-
-Syntax highlighting:
-
-```js
-var foo = function (bar) {
- return bar++;
-};
-
-console.log(foo(5));
-```
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.js
deleted file mode 100644
index 7585b54..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/markdown/\",\"title\":\"Markdown Introduction\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Markdown Introduction\",\"icon\":\"fab fa-markdown\",\"dir\":{\"collapsible\":false,\"order\":1},\"category\":[\"Cookbook\",\"Markdown\"],\"tag\":[\"Intro\",\"Markdown\"],\"description\":\"Markdown is a markup language that can be written using a plain text editor that allows plain text content to be formatted with simple markup syntax. Markdown has a series of de...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/markdown/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/markdown/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/markdown/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Markdown Introduction\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Markdown is a markup language that can be written using a plain text editor that allows plain text content to be formatted with simple markup syntax. Markdown has a series of de...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Markdown Introduction\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Usage\",\"slug\":\"usage\",\"link\":\"#usage\",\"children\":[]},{\"level\":2,\"title\":\"ShortCut Key\",\"slug\":\"shortcut-key\",\"link\":\"#shortcut-key\",\"children\":[]},{\"level\":2,\"title\":\"Title\",\"slug\":\"title\",\"link\":\"#title\",\"children\":[]},{\"level\":2,\"title\":\"Text Style\",\"slug\":\"text-style\",\"link\":\"#text-style\",\"children\":[]},{\"level\":2,\"title\":\"Link\",\"slug\":\"link\",\"link\":\"#link\",\"children\":[]},{\"level\":2,\"title\":\"Image\",\"slug\":\"image\",\"link\":\"#image\",\"children\":[]},{\"level\":2,\"title\":\"Tables\",\"slug\":\"tables\",\"link\":\"#tables\",\"children\":[]},{\"level\":2,\"title\":\"Emoji\",\"slug\":\"emoji\",\"link\":\"#emoji\",\"children\":[]},{\"level\":2,\"title\":\"Markdown Display\",\"slug\":\"markdown-display\",\"link\":\"#markdown-display\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.43,\"words\":429},\"filePathRelative\":\"cookbook/markdown/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.vue
deleted file mode 100644
index bc1c1e6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/markdown/index.html.vue
+++ /dev/null
@@ -1,98 +0,0 @@
-
Markdown is a markup language that can be written using a plain text editor that allows plain text content to be formatted with simple markup syntax.
-
Markdown has a series of derivative versions that extend Markdown's functionality (such as tables, footnotes, embedded HTML, etc.). These features were not available in the original Markdown. They can convert Markdown into more formats, such as LaTeX, Docbook, Markdown Extra, MultiMarkdown, Maruku, etc. are more famous in Markdown's enhanced version. These derivative versions are either based on tools such as Pandoc; or based on sites such as GitHub and Wikipedia, which are syntactically compatible, but have some changes in syntax and rendering effects.
Markdown's grammar is simple and straightforward, easy to learn, and features more powerful than plain text, so people use it to write blogs. WordPress, the world's most popular blogging platform, and large CMSs such as Joomla and Drupal all support Markdown. The blog platforms that use the Markdown editor are Ghost and Typecho.
-
Used to write documentation and save it under the software's directory under the filename README.md. Because we have a god-level editor like RStudio, we can turn Markdown into a presentation PPT, Word product documentation, LaTex papers, and even a minimally usable prototype with little code. In the field of data science, Markdown has been widely used, greatly promoting the historical process of dynamic repeatability research.
The title shows the structure of the article. Insert 1-6 # at the beginning of the line, each adding a # indicates a more in-depth content, corresponding to the depth of the title by 1-6.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.js
deleted file mode 100644
index ea795c5..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/config.html\",\"title\":\"VuePress Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"VuePress Config\",\"icon\":\"gears\",\"order\":4,\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Config\",\"VuePress\"],\"description\":\"Config File Without any configuration, the VuePress site is pretty minimal. To customize your site, let's first create a .vuepress directory inside your docs directory. This is ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/config.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/config.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/config.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"VuePress Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Config File Without any configuration, the VuePress site is pretty minimal. To customize your site, let's first create a .vuepress directory inside your docs directory. This is ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Config\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"VuePress Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Config File\",\"slug\":\"config-file\",\"link\":\"#config-file\",\"children\":[]},{\"level\":2,\"title\":\"Config Scopes\",\"slug\":\"config-scopes\",\"link\":\"#config-scopes\",\"children\":[{\"level\":3,\"title\":\"Site Config\",\"slug\":\"site-config\",\"link\":\"#site-config\",\"children\":[]},{\"level\":3,\"title\":\"Theme Config\",\"slug\":\"theme-config\",\"link\":\"#theme-config\",\"children\":[]}]},{\"level\":2,\"title\":\"Client Config File\",\"slug\":\"client-config-file\",\"link\":\"#client-config-file\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.32,\"words\":397},\"filePathRelative\":\"cookbook/vuepress/config.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.vue
deleted file mode 100644
index c82511f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/config.html.vue
+++ /dev/null
@@ -1,85 +0,0 @@
-
Without any configuration, the VuePress site is pretty minimal. To customize your site, let's first create a .vuepress directory inside your docs directory. This is where all VuePress-specific files will be placed. Your project structure is probably like this:
The essential file for configuring a VuePress site is .vuepress/config.js, while TypeScript config file is also supported. You can use .vuepress/config.ts instead to get better types hint for VuePress config.
In most cases, the config file is sufficient to configure your VuePress site. However, sometimes users may want to add some client-side code directly. To help with this, VuePress also supports a client config file:
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/index.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/index.html.js
deleted file mode 100644
index efcf280..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/index.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/\",\"title\":\"About VuePress\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"About VuePress\",\"icon\":\"fab fa-vuejs\",\"dir\":{\"collapsible\":false,\"order\":2},\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Intro\",\"VuePress\"],\"prev\":\"../markdown/demo.html\",\"description\":\"VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static sit...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"About VuePress\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static sit...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"About VuePress\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"How It Works\",\"slug\":\"how-it-works\",\"link\":\"#how-it-works\",\"children\":[]},{\"level\":2,\"title\":\"VuePress Intro\",\"slug\":\"vuepress-intro\",\"link\":\"#vuepress-intro\",\"children\":[]},{\"level\":2,\"title\":\"VuePress Official Docs\",\"slug\":\"vuepress-official-docs\",\"link\":\"#vuepress-official-docs\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.73,\"words\":218},\"filePathRelative\":\"cookbook/vuepress/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static site to host them.
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static site to host them.
A VuePress site is in fact a single-page application (SPA) powered by Vue and Vue Router.
-
Routes are generated according to the relative path of your Markdown files. Each Markdown file is compiled into HTML with markdown-it and then processed as the template of a Vue component. This allows you to directly use Vue inside your Markdown files and is great when you need to embed dynamic content.
-
-
-
During development, we start a normal dev-server, and serve the VuePress site as a normal SPA. If you've used Vue before, you will notice the familiar development experience when you are writing and developing with VuePress.
-
-
-
During build, we create a server-rendered version of the VuePress site and render the corresponding HTML by virtually visiting each route.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.js
deleted file mode 100644
index 3bbf348..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/markdown.html\",\"title\":\"Builtin Markdown features\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Builtin Markdown features\",\"icon\":\"fab fa-markdown\",\"order\":2,\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Markdown\",\"VuePress\"],\"description\":\"Here are some enhance VuePress makes on Markdown syntax. Syntax Extensions The Markdown content in VuePress will be parsed by markdown-it, which supports syntax extensions via m...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/markdown.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/markdown.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/markdown.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Builtin Markdown features\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Here are some enhance VuePress makes on Markdown syntax. Syntax Extensions The Markdown content in VuePress will be parsed by markdown-it, which supports syntax extensions via m...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Builtin Markdown features\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Syntax Extensions\",\"slug\":\"syntax-extensions\",\"link\":\"#syntax-extensions\",\"children\":[{\"level\":3,\"title\":\"Embedded\",\"slug\":\"embedded\",\"link\":\"#embedded\",\"children\":[]},{\"level\":3,\"title\":\"Header Anchors\",\"slug\":\"header-anchors\",\"link\":\"#header-anchors\",\"children\":[]},{\"level\":3,\"title\":\"Links\",\"slug\":\"links\",\"link\":\"#links\",\"children\":[]},{\"level\":3,\"title\":\"Emoji\",\"slug\":\"emoji\",\"link\":\"#emoji\",\"children\":[]},{\"level\":3,\"title\":\"Table of Contents\",\"slug\":\"table-of-contents\",\"link\":\"#table-of-contents\",\"children\":[]},{\"level\":3,\"title\":\"Code Blocks\",\"slug\":\"code-blocks\",\"link\":\"#code-blocks\",\"children\":[]},{\"level\":3,\"title\":\"Import Code Blocks\",\"slug\":\"import-code-blocks\",\"link\":\"#import-code-blocks\",\"children\":[]}]},{\"level\":2,\"title\":\"Using Vue in Markdown\",\"slug\":\"using-vue-in-markdown\",\"link\":\"#using-vue-in-markdown\",\"children\":[{\"level\":3,\"title\":\"Template Syntax\",\"slug\":\"template-syntax\",\"link\":\"#template-syntax\",\"children\":[]},{\"level\":3,\"title\":\"Components\",\"slug\":\"components\",\"link\":\"#components\",\"children\":[]}]},{\"level\":2,\"title\":\"Cautions\",\"slug\":\"cautions\",\"link\":\"#cautions\",\"children\":[{\"level\":3,\"title\":\"Deprecated HTML Tags\",\"slug\":\"deprecated-html-tags\",\"link\":\"#deprecated-html-tags\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":5.79,\"words\":1736},\"filePathRelative\":\"cookbook/vuepress/markdown.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.vue
deleted file mode 100644
index 1463866..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/markdown.html.vue
+++ /dev/null
@@ -1,309 +0,0 @@
-
Here are some enhance VuePress makes on Markdown syntax.
The Markdown content in VuePress will be parsed by markdown-it, which supports syntax extensions via markdown-it plugins.
-
This section will introduce built-in Markdown syntax extensions of VuePress.
-
You can also configure those built-in extensions, load more markdown-it plugins and implement your own extensions via markdown option and extendsMarkdown option.
You might have noticed that, a # anchor is displayed when you hover the mouse on the headers of each section. By clicking the # anchor, you can jump to the section directly.
You must have noticed that the number of lines is displayed on the left side of code blocks. This is enabled by default, and you can disable it in config.
-
You can add :line-numbers / :no-line-numbers mark in your fenced code blocks to override the value set in config.
-
Input:
-
```ts
-// line-numbers is enabled by default
-const line2 = "This is line 2";
-const line3 = "This is line 3";
-```
-
-```ts:no-line-numbers
-// line-numbers is disabled
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-```
-
Output:
-
// line-numbers is enabled by default
-const line2 = "This is line 2";
-const line3 = "This is line 3";
-
// line-numbers is disabled
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-
-
Tips
-
This line numbers extension is supported by our built-in plugin.
To avoid your code blocks being compiled by Vue, VuePress will add v-pre directive to your code blocks by default, which can be disabled in config.
-
You can add :v-pre / :no-v-pre mark in your fenced code blocks to override the value set in config.
-
-
Warning
-
The template syntax characters, for example, the "Mustache" syntax (double curly braces) might be parsed by the syntax highlighter. Thus, as the following example, :no-v-pre might not work well in some languages.
-
To make Vue syntax work in those languages anyway, try to disable the default syntax highlighting and implement your own syntax highlighting in client-side.
-
-
Input:
-
```md
-<!-- This will be kept as is by default -->
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-```md:no-v-pre
-<!-- This will be compiled by Vue -->
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-```js:no-v-pre
-// This won't be compiled correctly because of js syntax highlighting
-const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
-```
-
Output:
-
<!-- This will be kept as is -->
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-
<!-- This will be compiled by Vue -->
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-
-
// This won't be compiled correctly because of js syntax highlighting
-const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
-
-
Tips
-
This v-pre extension is supported by our built-in plugin.
You can import code blocks from files with following syntax:
-
<!-- minimal syntax -->
-
-@[code](../foo.js)
-
To partially import the file:
-
<!-- partial import, from line 1 to line 10 -->
-
-@[code{1-10}](../foo.js)
-
The code language is inferred from the file extension, while it is recommended to specify it explicitly:
-
<!-- specify the code language -->
-
-@[code js](../foo.js)
-
In fact, the second part inside the [] will be treated as the mark of the code fence, so it supports all the syntax mentioned in the above Code Blocks section:
-
<!-- line highlighting -->
-
-@[code js{2,4-5}](../foo.js)
-
Here is a complex example:
-
-
import line 3 to line 10 of the "../foo.js" file
-
specify the language as "js"
-
highlight line 3 of the imported code, i.e. line 5 of the "../foo.js" file
-
disable line numbers
-
-
@[code{3-10} js{3}:no-line-numbers](../foo.js)
-
Notice that path aliases are not available in import code syntax. You can use following config to handle path alias yourself:
Deprecated HTML tags such as <center> and <font> are not allowed in VuePress Markdown by default.
-
Those tags would not be recognized as native HTML tags by Vue template compiler. Instead, Vue will try to resolve those tags as Vue components, and obviously these components usually don't exist.
-
You should try to avoid using deprecated HTML tags. However, to use those tags anyway, try either of the following workarounds:
-
-
Adding a v-pre directive to skip the compilation of the element and its children. Notice that the template syntax would also be invalid.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.js
deleted file mode 100644
index af23733..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/page.html\",\"title\":\"VuePress Page\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"VuePress Page\",\"icon\":\"file\",\"order\":1,\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Page\",\"VuePress\"],\"description\":\"VuePress is markdown-centered. Each Markdown file inside your project is a standalone page. Routing By default, the route path of a page is determined by the relative path of yo...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/page.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/page.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/page.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"VuePress Page\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"VuePress is markdown-centered. Each Markdown file inside your project is a standalone page. Routing By default, the route path of a page is determined by the relative path of yo...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Page\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"VuePress Page\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Routing\",\"slug\":\"routing\",\"link\":\"#routing\",\"children\":[]},{\"level\":2,\"title\":\"Frontmatter\",\"slug\":\"frontmatter\",\"link\":\"#frontmatter\",\"children\":[]},{\"level\":2,\"title\":\"Content\",\"slug\":\"content\",\"link\":\"#content\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.03,\"words\":309},\"filePathRelative\":\"cookbook/vuepress/page.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.vue
deleted file mode 100644
index a295583..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/page.html.vue
+++ /dev/null
@@ -1,57 +0,0 @@
-
VuePress is markdown-centered. Each Markdown file inside your project is a standalone page.
A Markdown file could contain a YAML frontmatter. The frontmatter must be at the top of the Markdown file and must be wrapped with a couple of triple-dashed lines. Here is a basic example:
-
---
-lang: en-US
-title: Title of this page
-description: Description of this page
----
-
You must have noticed that those fields are similar with the Site Config in Config File. You can override lang, title, description, etc., of current page via frontmatter. So you can take frontmatter as page scope config.
-
Also, VuePress has built-in support for some frontmatter fields, and your theme may have its own special frontmatter, too.
-
-
Tips
-
Check out the Frontmatter Reference for a full list of VuePress built-in frontmatter.
-
Check out the Config > Frontmatter for the frontmatter of vuepress-theme-hope.
The main content of your page is written in Markdown. VuePress will firstly transform your Markdown to HTML code, then treat the HTML code as <template> of Vue SFC.
-
With the power of markdown-it and Vue template syntax, the basic Markdown can be extended a lot. Next, check out the Markdown guide for all the extensions of Markdown in VuePress.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.js
deleted file mode 100644
index 2012c63..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/plugin.html\",\"title\":\"Plugins\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Plugins\",\"icon\":\"puzzle-piece\",\"order\":5,\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Plugin\",\"VuePress\"],\"description\":\"With the help of Plugin API, VuePress plugin can provide different features for you. Community Plugin Community users have created lots of plugins and published them to NPM. Vue...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/plugin.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/plugin.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/plugin.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Plugins\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"With the help of Plugin API, VuePress plugin can provide different features for you. Community Plugin Community users have created lots of plugins and published them to NPM. Vue...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Plugin\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Plugins\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Community Plugin\",\"slug\":\"community-plugin\",\"link\":\"#community-plugin\",\"children\":[]},{\"level\":2,\"title\":\"Local Plugin\",\"slug\":\"local-plugin\",\"link\":\"#local-plugin\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.95,\"words\":284},\"filePathRelative\":\"cookbook/vuepress/plugin.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.vue
deleted file mode 100644
index 3dfb7d9..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/plugin.html.vue
+++ /dev/null
@@ -1,31 +0,0 @@
-
With the help of Plugin API, VuePress plugin can provide different features for you.
Community users have created lots of plugins and published them to NPM. VuePress team also maintains some official plugins under the @vuepress scope. You should check the plugin's own documentation for detailed guide.
-
In general, you need to include the plugin in the plugins option to use it. For example, use the @vuepress/plugin-google-analytics to integrate Google Analytics:
Most plugins can only be used once. If the same plugin is used multiple times, only the last one will take effect.
-
However, some plugins can be used multiple times (e.g. @vuepress/plugin-container), and you should check the documentation of the plugin itself for detailed guide.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.js b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.js
deleted file mode 100644
index 949c0b4..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.vue"
-const data = JSON.parse("{\"path\":\"/cookbook/vuepress/theme.html\",\"title\":\"Theme Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Config\",\"icon\":\"palette\",\"order\":6,\"category\":[\"Cookbook\",\"VuePress\"],\"tag\":[\"Theme\",\"VuePress\"],\"description\":\"VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content. Default Theme VuePress has a default theme out of t...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/cookbook/vuepress/theme.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/cookbook/vuepress/theme.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/cookbook/vuepress/theme.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content. Default Theme VuePress has a default theme out of t...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"VuePress\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Default Theme\",\"slug\":\"default-theme\",\"link\":\"#default-theme\",\"children\":[]},{\"level\":2,\"title\":\"Community Theme\",\"slug\":\"community-theme\",\"link\":\"#community-theme\",\"children\":[]},{\"level\":2,\"title\":\"Local Theme\",\"slug\":\"local-theme\",\"link\":\"#local-theme\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.84,\"words\":252},\"filePathRelative\":\"cookbook/vuepress/theme.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.vue b/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.vue
deleted file mode 100644
index 20c8e4e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/cookbook/vuepress/theme.html.vue
+++ /dev/null
@@ -1,27 +0,0 @@
-
VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content.
The default theme provides basic but useful features for documentation site, you can check out Default Theme Config Reference for a full list of config.
-
However, you might think it is not good enough. Or, you want to build a different type of site, for example, a blog, instead of a documentation. Then, you can try to use a community theme or create a local theme.
If you want to use your own custom theme but don't want to publish it, you can create a local theme. Refer to Advanced > Writing a Theme for how to write your own theme.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.js b/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.js
deleted file mode 100644
index 62c4d6e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.vue"
-const data = JSON.parse("{\"path\":\"/demo/blog-home.html\",\"title\":\"Blog Home\",\"lang\":\"en-US\",\"frontmatter\":{\"home\":true,\"layout\":\"BlogHome\",\"icon\":\"home\",\"title\":\"Blog Home\",\"heroImage\":\"https://theme-hope-assets.vuejs.press/logo.svg\",\"heroText\":\"The name of your blog\",\"tagline\":\"You can put your slogan here\",\"heroFullScreen\":true,\"projects\":[{\"icon\":\"project\",\"name\":\"project name\",\"desc\":\"project detailed description\",\"link\":\"https://your.project.link\"},{\"icon\":\"link\",\"name\":\"link name\",\"desc\":\"link detailed description\",\"link\":\"https://link.address\"},{\"icon\":\"book\",\"name\":\"book name\",\"desc\":\"Detailed description of the book\",\"link\":\"https://link.to.your.book\"},{\"icon\":\"article\",\"name\":\"article name\",\"desc\":\"Detailed description of the article\",\"link\":\"https://link.to.your.article\"},{\"icon\":\"friend\",\"name\":\"friend name\",\"desc\":\"Detailed description of friend\",\"link\":\"https://link.to.your.friend\"},{\"icon\":\"https://theme-hope-assets.vuejs.press/logo.svg\",\"name\":\"custom item\",\"desc\":\"Detailed description of this custom item\",\"link\":\"https://link.to.your.friend\"}],\"footer\":\"customize your footer text\",\"description\":\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/demo/blog-home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/demo/blog-home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/demo/blog-home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog Home\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"website\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"WebPage\\\",\\\"name\\\":\\\"Blog Home\\\",\\\"description\\\":\\\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\\\"}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.52,\"words\":156},\"filePathRelative\":\"demo/blog-home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.vue b/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.vue
deleted file mode 100644
index 781e9ba..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/blog-home.html.vue
+++ /dev/null
@@ -1,6 +0,0 @@
-
This is a blog home page demo.
-
To use this layout, you should set both layout: BlogHome and home: true in the page front matter.
-
For related configuration docs, please see blog homepage.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.js b/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.js
deleted file mode 100644
index ca38fad..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.vue"
-const data = JSON.parse("{\"path\":\"/demo/custom-blog-home.html\",\"title\":\"Customized Blog Home\",\"lang\":\"en-US\",\"frontmatter\":{\"home\":true,\"layout\":\"CustomBlogHome\",\"icon\":\"home\",\"title\":\"Customized Blog Home\",\"heroImage\":\"https://theme-hope-assets.vuejs.press/logo.svg\",\"heroText\":\"The name of your blog\",\"tagline\":\"You can put your slogan here\",\"heroFullScreen\":true,\"projects\":[{\"icon\":\"project\",\"name\":\"project name\",\"desc\":\"project detailed description\",\"link\":\"https://your.project.link\"},{\"icon\":\"link\",\"name\":\"link name\",\"desc\":\"link detailed description\",\"link\":\"https://link.address\"},{\"icon\":\"book\",\"name\":\"book name\",\"desc\":\"Detailed description of the book\",\"link\":\"https://link.to.your.book\"},{\"icon\":\"article\",\"name\":\"article name\",\"desc\":\"Detailed description of the article\",\"link\":\"https://link.to.your.article\"},{\"icon\":\"friend\",\"name\":\"friend name\",\"desc\":\"Detailed description of friend\",\"link\":\"https://link.to.your.friend\"},{\"icon\":\"https://theme-hope-assets.vuejs.press/logo.svg\",\"name\":\"custom item\",\"desc\":\"Detailed description of this custom item\",\"link\":\"https://link.to.your.friend\"}],\"footer\":\"customize your footer text\",\"description\":\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/demo/custom-blog-home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/demo/custom-blog-home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/demo/custom-blog-home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Customized Blog Home\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"website\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"WebPage\\\",\\\"name\\\":\\\"Customized Blog Home\\\",\\\"description\\\":\\\"This is a blog home page demo. To use this layout, you should set both layout: BlogHome and home: true in the page front matter. For related configuration docs, please see .\\\"}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.52,\"words\":157},\"filePathRelative\":\"demo/custom-blog-home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.vue b/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.vue
deleted file mode 100644
index 781e9ba..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/custom-blog-home.html.vue
+++ /dev/null
@@ -1,6 +0,0 @@
-
This is a blog home page demo.
-
To use this layout, you should set both layout: BlogHome and home: true in the page front matter.
-
For related configuration docs, please see blog homepage.
Paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text paragraph 1 text.
-
Paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text paragraph 2 text.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.js b/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.js
deleted file mode 100644
index 8515cf6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.vue"
-const data = JSON.parse("{\"path\":\"/demo/portfolio-home.html\",\"title\":\"Portfolio Home\",\"lang\":\"en-US\",\"frontmatter\":{\"home\":true,\"layout\":\"PortfolioHome\",\"title\":\"Portfolio Home\",\"icon\":\"home\",\"name\":\"Conan Edogawa\",\"avatar\":\"https://theme-hope-assets.vuejs.press/hero/conan.png\",\"titles\":[\"Genius young detective\",\"Lan’s childhood sweetheart\",\"The biggest rival of the black organization\"],\"footer\":false,\"description\":\"This is a portfolio home page demo. To use this layout, you should set both layout: PortfolioHome and home: true in the page front matter. For related configuration docs, please...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/demo/portfolio-home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/demo/portfolio-home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/demo/portfolio-home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Portfolio Home\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This is a portfolio home page demo. To use this layout, you should set both layout: PortfolioHome and home: true in the page front matter. For related configuration docs, please...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"website\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"WebPage\\\",\\\"name\\\":\\\"Portfolio Home\\\",\\\"description\\\":\\\"This is a portfolio home page demo. To use this layout, you should set both layout: PortfolioHome and home: true in the page front matter. For related configuration docs, please...\\\"}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.24,\"words\":72},\"filePathRelative\":\"demo/portfolio-home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.vue b/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.vue
deleted file mode 100644
index 8ab97a0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/portfolio-home.html.vue
+++ /dev/null
@@ -1,6 +0,0 @@
-
This is a portfolio home page demo.
-
To use this layout, you should set both layout: PortfolioHome and home: true in the page front matter.
-
For related configuration docs, please see portfolio homepage.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.js b/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.js
deleted file mode 100644
index b660a9c..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.vue"
-const data = JSON.parse("{\"path\":\"/demo/projects.html\",\"title\":\"Real Projects\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Real Projects\",\"icon\":\"splotch\",\"order\":1,\"category\":[\"Demo\"],\"docs\":[{\"name\":\"Waline\",\"desc\":\"A Simple, Safe Comment System.\",\"logo\":\"https://waline.js.org/logo.png\",\"url\":\"https://waline.js.org/en/\",\"repo\":\"https://github.com/walinejs/waline\",\"preview\":\"/assets/image/waline.jpg\"},{\"name\":\"zkSync Era\",\"desc\":\"A trustless protocol that uses cryptographic validity proofs to provide scalable and low-cost transactions on Ethereum\",\"logo\":\"https://docs.zksync.io/zksync_logo_black.svg\",\"url\":\"https://docs.zksync.io/\",\"repo\":\"https://github.com/matter-labs/zksync-web-era-docs\",\"preview\":\"/assets/image/zksync.jpg\"},{\"name\":\"SubQuery\",\"desc\":\"SubQuery is a leading web3 data indexer that provides fast, flexible, and decentralised APIs for web3 projects\",\"logo\":\"https://static.subquery.network/icon.png\",\"url\":\"https://academy.subquery.network\",\"repo\":\"https://github.com/subquery/documentation\",\"preview\":\"/assets/image/subquery.jpg\"},{\"name\":\"mdit-plugins\",\"desc\":\"Plugin collections of MarkdownIt\",\"logo\":\"https://mdit-plugins.github.io/logo.svg\",\"url\":\"https://mdit-plugins.github.io/\",\"repo\":\"https://github.com/mdit-plugins/mdit-plugins/\",\"preview\":\"/assets/image/mdit-plugins.jpg\"},{\"name\":\"Apache IoTDB\",\"desc\":\"An IoT native database with high performance for data management and analysis\",\"logo\":\"https://iotdb.apache.org/logo.png\",\"url\":\"https://iotdb.apache.org/\",\"repo\":\"https://github.com/apache/iotdb\",\"preview\":\"/assets/image/iotdb.jpg\"},{\"name\":\"ZLMediaKit\",\"desc\":\"An high-performance, enterprise-level streaming media service framework based on C++11.\",\"url\":\"https://docs.zlmediakit.com/\",\"repo\":\"https://github.com/ZLMediaKit/docs\",\"preview\":\"/assets/image/zlmediakit.jpg\"},{\"name\":\"abapGit\",\"desc\":\"A git client for ABAP developed in ABAP\",\"logo\":\"https://docs.abapgit.org/logo-dark.svg\",\"url\":\"https://docs.abapgit.org/\",\"repo\":\"https://github.com/abapGit/docs.abapgit.org\",\"preview\":\"/assets/image/abap-git.jpg\"},{\"name\":\"bitsail\",\"desc\":\"A high-performance data integration engine based on distributed architecture, supporting data synchronization between multiple heterogeneous data sources.\",\"logo\":\"https://bytedance.github.io/bitsail/bitsail_logo.png\",\"url\":\"https://bytedance.github.io/bitsail/\",\"repo\":\"https://github.com/bytedance/bitsail\",\"preview\":\"/assets/image/bitsail.jpg\"},{\"name\":\"Fast Request\",\"desc\":\"Born to simplify debugging APIs\",\"logo\":\"https://dromara.org/fast-request/img/logo/logo.svg\",\"url\":\"https://dromara.org/fast-request/en/\",\"repo\":\"https://github.com/dromara/fast-request\",\"preview\":\"/assets/image/fast-request.jpg\"},{\"name\":\"Crawlab\",\"desc\":\"A powerful Web Crawler Management Platform (WCMP)\",\"logo\":\"https://docs.crawlab.cn/logo.svg\",\"url\":\"https://docs.crawlab.cn/en/guide/\",\"repo\":\"https://github.com/crawlab-team/crawlab-docs\",\"preview\":\"/assets/image/crawlab.jpg\"},{\"name\":\"Nosana\",\"desc\":\"Next Gen CI/CD\",\"logo\":\"https://nosana.io/img/NOS_logo.png\",\"url\":\"https://docs.nosana.io/\",\"repo\":\"https://github.com/nosana-ci/docs.nosana.io\",\"preview\":\"/assets/image/nosana.jpg\"},{\"name\":\"Pulsar\",\"desc\":\"A Community-led Hyper-Hackable Text Editor\",\"logo\":\"https://pulsar-edit.dev/logo-name-navbar-light.svg\",\"url\":\"https://pulsar-edit.dev/\",\"repo\":\"https://github.com/pulsar-edit/pulsar-edit.github.io\",\"preview\":\"/assets/image/plusar.jpg\"},{\"name\":\"FreeSql\",\"desc\":\"Powerful O/RM component,Support .NET Core 2.1+、.NET Framework 4.0+ and Xamarin✨\",\"logo\":\"https://freesql.net/logo.png\",\"url\":\"https://freesql.net/en/\",\"repo\":\"https://github.com/dotnetcore/FreeSql/tree/master/docs\",\"preview\":\"/assets/image/free-sql.jpg\"},{\"name\":\"ct.js\",\"desc\":\"Learn ct.js, complete tutorials, and contribute to ct.js documentation\",\"logo\":\"https://docs.ctjs.rocks/assets/img/logo.png\",\"url\":\"https://docs.ctjs.rocks/\",\"repo\":\"https://github.com/ct-js/docs.ctjs.rocks\",\"preview\":\"/assets/image/ctjs.jpg\"},{\"name\":\"DXOS\",\"desc\":\"The Operating System for Decentralized Software\",\"logo\":\"https://docs.dxos.org/images/logotype/dxos-hero.svg\",\"url\":\"https://docs.dxos.org/\",\"repo\":\"https://github.com/dxos/dxos\",\"preview\":\"/assets/image/dxos.jpg\"},{\"name\":\"UIGF-org\",\"desc\":\"Unified Standardized GenshinData Format\",\"logo\":\"https://uigf.org/uigf-logo128.png\",\"url\":\"https://uigf.org/en/\",\"repo\":\"https://github.com/UIGF-org/UIGF-org.github.io\",\"preview\":\"/assets/image/uigf.jpg\"},{\"name\":\"simple-admin\",\"desc\":\"A powerful microservice framework for large management system\",\"logo\":\"https://doc.ryansu.tech/logo.svg\",\"url\":\"https://doc.ryansu.tech/\",\"repo\":\"https://github.com/suyuan32/simple-admin-doc\",\"preview\":\"/assets/image/simple-admin.jpg\"},{\"name\":\"ALIST\",\"desc\":\"A file list program that supports multiple storage, powered by Gin and Solidjs.\",\"logo\":\"https://alist.nn.ci/logo.svg\",\"url\":\"https://alist.nn.ci/\",\"repo\":\"https://github.com/alist-org/docs\",\"preview\":\"/assets/image/alist.jpg\"},{\"name\":\"Taskiq\",\"logo\":\"https://taskiq-python.github.io/logo.svg\",\"desc\":\"Distributed task queue with full async support\",\"url\":\"https://taskiq-python.github.io/\",\"repo\":\"https://github.com/taskiq-python/taskiq/tree/master/docs\",\"preview\":\"/assets/image/taskiq.jpg\"},{\"name\":\"Gorse\",\"desc\":\"An open-source recommender system service written in Go.\",\"logo\":\"https://gorse.io/logo.png\",\"url\":\"https://gorse.io\",\"repo\":\"https://github.com/gorse-io/docs\",\"preview\":\"/assets/image/gorse.jpg\"},{\"name\":\"Suibase\",\"desc\":\"Open-Source Development Tools and Community Cookbook\",\"logo\":\"https://suibase.io/logo.png\",\"url\":\"https://suibase.io/\",\"repo\":\"https://github.com/ChainMovers/suibase\",\"preview\":\"/assets/image/suibase.jpg\"},{\"name\":\"TimeHelper\",\"desc\":\"A smart PHP datetime helper library ✨\",\"logo\":\"https://time.0x1.site/logo.svg\",\"url\":\"https://time.0x1.site/en/\",\"repo\":\"https://github.com/zjkal/time-helper\",\"preview\":\"/assets/image/time-helper.jpg\"},{\"name\":\"Rundeck\",\"desc\":\"Enable Self-Service Operations: Give specific users access to your existing tools, services, and script\",\"logo\":\"https://docs.rundeck.com/docs/images/RundeckbyPagerDuty.svg\",\"url\":\"https://docs.rundeck.com/docs/\",\"repo\":\"https://github.com/rundeck/docs\",\"preview\":\"/assets/image/rundeck.jpg\"},{\"name\":\"TgWebValid\",\"desc\":\"An easy way to validate Telegram users.\",\"logo\":\"https://tgwebvalid.com/logo.svg\",\"url\":\"https://tgwebvalid.com/en/\",\"repo\":\"https://github.com/CrazyTapok-bit/tgWebValid\",\"preview\":\"/assets/image/tgwebvalid.png\"},{\"name\":\"Korepi\",\"desc\":\"Providing high-quality and user-friendly Korepi utility tools!\",\"logo\":\"https://korepi.com/logo2.svg\",\"url\":\"https://korepi.com/en/\",\"repo\":\"https://github.com/Korepi/korepi-docs\",\"preview\":\"/assets/image/korepi.jpg\"},{\"name\":\"Watt Toolkit\",\"desc\":\"A multi-purpose Steam toolkit\",\"logo\":\"https://xtsat.github.io/SteamTools-Guide/logo/Steam++Logo_1024.png\",\"url\":\"https://xtsat.github.io/SteamTools-Guide/en/\",\"repo\":\"https://github.com/XTsat/SteamTools-Guide\",\"preview\":\"/assets/image/watt.jpg\"},{\"name\":\"Murex\",\"desc\":\"An intuitive, typed and content aware shell for the 2020s and beyond.\",\"logo\":\"https://murex.rocks/murex.svg\",\"url\":\"https://murex.rocks/\",\"repo\":\"https://github.com/lmorg/murex\",\"preview\":\"/assets/image/murex.jpg\"},{\"name\":\"ShokaX\",\"desc\":\"Highly customizable Hexo theme that sets your blog apart\",\"url\":\"https://docs.kaitaku.xyz/en/\",\"repo\":\"https://github.com/theme-shoka-x/shokaX-docs\",\"preview\":\"/assets/image/shokax.jpg\"}],\"blog\":[{\"name\":\"Mr.Hope's Blog\",\"desc\":\"Where there is light, there is hope\",\"logo\":\"https://mister-hope.com/logo.svg\",\"url\":\"https://mister-hope.com\",\"repo\":\"https://github.com/Mister-Hope/Mister-Hope.github.io\",\"preview\":\"/assets/image/mrhope.jpg\"},{\"name\":\"Mo7's Blog\",\"desc\":\"Something wonderful is about to happen.\",\"logo\":\"https://file.mo7.cc/static/lxh_gif/lxh_71.gif\",\"url\":\"https://blog.mo7.cc/en/\",\"repo\":\"https://github.com/mo7cc/BlogSource.git\",\"preview\":\"https://file.mo7.cc/disk/blog_preview_en.png\"},{\"name\":\"Guo's Page\",\"desc\":\"Project documentation and study notes\",\"logo\":\"https://guoxicheng.top/logo.png\",\"url\":\"https://guoxicheng.top/en\",\"repo\":\"https://github.com/GuoXiCheng/guoxicheng.github.io\",\"preview\":\"/assets/image/guo-s-page-en.png\"}],\"description\":\"Docs using VuePress Theme Hope\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/demo/projects.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/demo/projects.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/demo/projects.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Real Projects\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Docs using VuePress Theme Hope\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Real Projects\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Docs using VuePress Theme Hope\",\"slug\":\"docs-using-vuepress-theme-hope\",\"link\":\"#docs-using-vuepress-theme-hope\",\"children\":[]},{\"level\":2,\"title\":\"Blog using VuePress Theme Hope\",\"slug\":\"blog-using-vuepress-theme-hope\",\"link\":\"#blog-using-vuepress-theme-hope\",\"children\":[]},{\"level\":2,\"title\":\"More\",\"slug\":\"more\",\"link\":\"#more\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.75,\"words\":825},\"filePathRelative\":\"demo/projects.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.vue b/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.vue
deleted file mode 100644
index 37d2607..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/projects.html.vue
+++ /dev/null
@@ -1,19 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/demo/slot.html.js b/docs/theme/src/.vuepress/.temp/pages/demo/slot.html.js
deleted file mode 100644
index 4bb1984..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/demo/slot.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/demo/slot.html.vue"
-const data = JSON.parse("{\"path\":\"/demo/slot.html\",\"title\":\"Slot Demo\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Slot Demo\",\"icon\":\"boxes-packing\",\"layout\":\"SlotDemo\",\"description\":\"This page shows how to use slots to customize the content of a page.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/demo/slot.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/demo/slot.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/demo/slot.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Slot Demo\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This page shows how to use slots to customize the content of a page.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Slot Demo\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Title used to trigger TOC\",\"slug\":\"title-used-to-trigger-toc\",\"link\":\"#title-used-to-trigger-toc\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.38,\"words\":113},\"filePathRelative\":\"demo/slot.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This page shows how to use slots to customize the content of a page.
You can customize the theme layout through these slots, and what you can do depends entirely on your imagination, such as:
-
-
Add a Telegram group button to your docs via the navbarEndBefore slot
-
Add a banner ad to your document or blog via the contentBefore slot
-
Add a donate button to your docs or blog via contentAfter slot
-
Add a list of sponsors to your docs or blogs via the tocBefore slot
-
Add a QR code to your docs or blog via the tocAfter slot
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.js
deleted file mode 100644
index a2782bf..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/common-error.html\",\"title\":\"Common Errors\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Common Errors\",\"icon\":\"triangle-exclamation\",\"order\":3,\"category\":[\"FAQ\"],\"description\":\"useXXX() is called without provider Such errors are usually caused by incorrectly containing multiple versions of vue in project. Make sure you are using the latest vuepress and...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/common-error.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/common-error.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/common-error.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Common Errors\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"useXXX() is called without provider Such errors are usually caused by incorrectly containing multiple versions of vue in project. Make sure you are using the latest vuepress and...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Common Errors\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"useXXX() is called without provider\",\"slug\":\"usexxx-is-called-without-provider\",\"link\":\"#usexxx-is-called-without-provider\",\"children\":[]},{\"level\":2,\"title\":\"Issues with peer dependencies found\",\"slug\":\"issues-with-peer-dependencies-found\",\"link\":\"#issues-with-peer-dependencies-found\",\"children\":[]},{\"level\":2,\"title\":\"You are not allowed to use plugin XXX yourself in vuepress config file.\",\"slug\":\"you-are-not-allowed-to-use-plugin-xxx-yourself-in-vuepress-config-file\",\"link\":\"#you-are-not-allowed-to-use-plugin-xxx-yourself-in-vuepress-config-file\",\"children\":[]},{\"level\":2,\"title\":\"FATAL ERROR: XXX - JavaScript heap out of memory\",\"slug\":\"fatal-error-xxx-javascript-heap-out-of-memory\",\"link\":\"#fatal-error-xxx-javascript-heap-out-of-memory\",\"children\":[]},{\"level\":2,\"title\":\"xxx isn't assign with a lang, and will return 'en-US' instead.\",\"slug\":\"xxx-isn-t-assign-with-a-lang-and-will-return-en-us-instead\",\"link\":\"#xxx-isn-t-assign-with-a-lang-and-will-return-en-us-instead\",\"children\":[]},{\"level\":2,\"title\":\"xxx is missing sidebar config.\",\"slug\":\"xxx-is-missing-sidebar-config\",\"link\":\"#xxx-is-missing-sidebar-config\",\"children\":[]},{\"level\":2,\"title\":\"xxx is not installed\",\"slug\":\"xxx-is-not-installed\",\"link\":\"#xxx-is-not-installed\",\"children\":[]},{\"level\":2,\"title\":\"[Vue warn]: Failed to resolve component: XXX\",\"slug\":\"vue-warn-failed-to-resolve-component-xxx\",\"link\":\"#vue-warn-failed-to-resolve-component-xxx\",\"children\":[]},{\"level\":2,\"title\":\"Hydration completed but contains mismatches.\",\"slug\":\"hydration-completed-but-contains-mismatches\",\"link\":\"#hydration-completed-but-contains-mismatches\",\"children\":[]},{\"level\":2,\"title\":\"HotReload not working in DevServer\",\"slug\":\"hotreload-not-working-in-devserver\",\"link\":\"#hotreload-not-working-in-devserver\",\"children\":[]},{\"level\":2,\"title\":\"Some page settings are invalid\",\"slug\":\"some-page-settings-are-invalid\",\"link\":\"#some-page-settings-are-invalid\",\"children\":[]},{\"level\":2,\"title\":\"Issues with styles\",\"slug\":\"issues-with-styles\",\"link\":\"#issues-with-styles\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":4.29,\"words\":1287},\"filePathRelative\":\"faq/common-error.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.vue
deleted file mode 100644
index fedf442..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/common-error.html.vue
+++ /dev/null
@@ -1,175 +0,0 @@
-
This means you have wrong deps installed in your project.
-
Here is a example:
-
WARN Issues with peer dependencies found
-.
-├─┬ @vuepress/plugin-docsearch 2.0.0-rc.7
-│ └── ✕ unmet peer vuepress@2.0.0-rc.2: found 2.0.0-rc.5
-├─┬ @vuepress/plugin-git 2.0.0-rc.7
-│ └── ✕ unmet peer vuepress@2.0.0-rc.2: found 2.0.0-rc.5
-├─┬ vuepress 2.0.0-rc.5
-│ └── ✕ unmet peer @vuepress/bundler-vite@2.0.0-rc.5: found 2.0.0-rc.4
-└─┬ vuepress-theme-hope 2.0.0-rc.21
- └── ✕ unmet peer @vuepress/plugin-docsearch@2.0.0-rc.10: found 2.0.0-rc.7
-
The example shows that:
-
-
-
vuepress requires a same version of @vuepress/bundler-vite as itself, but you have rc.4 bundler and rc.5 vuepress.
-
-
-
Some of the plugin requires vuepress@2.0.0-rc.2, while you have vuepress@2.0.0-rc.5.
-
-
-
You can always edit your deps version to let them fit each other. Usually you are trying to upgrade vuepress, vuepress bundler and plugins to latest version, but there could be chances where a plugin is not compatible with the latest version of vuepress. In this case, you should downgrade vuepress to the version that is compatible with the plugin or temporarily removing the plugin till it supports latest vuepress.
This means you are calling a theme-bundled plugin yourself in VuePress config file.
-
-
In most cases, when you use some plugins with theme, the theme automatically handles some plugin options for you,
-
Some plugins are required by the theme. If you do not enable the features used by theme, the theme will throw errors.
-
-
So when you want to customize these plugins, you should set their options in plugins.PLUGIN_NAME under theme options and let the theme call these plugins for you.
-
For details on all plugins of the theme, please see Theme Plugins.
This means that your max_old_space_size setting of Node.js is too small to build this application. You can try to increase the max_old_space_size by setting the NODE_OPTIONS environment variable.
-
max_old_space_size is in unit of MB, by default it is half size of your machine memory.
-
This value can be greater than the actual memory size of your machine.
-
-
For small projects, usually it won't take more than 2 GB (2048 MB).
-
For large projects, usually it won't take more than 4 GB (4048 MB)
-
If you are enabling blog feature together with lots of markdown enhance features on large sites, usually it won't take more than 8 GB (8192 MB)
-
-Ways of increasing
-
With GitHub workflow, set env in your workflow file.
If you see xxx isn't assign with a lang, and will return 'en-US' instead. while the dev process is starting up, please check whether you set lang for every language.
-
Even if you only have one language, you still need to set language.
Using object format sidebar config means you want to set different sidebar based on routes.
-
-
If you want to avoid this warning, you need to add sidebar config for rootLocale path, since all pages will fall back to that.
-
If you want to disable sidebar in current route, set sidebar: false in frontmatter.
-
If you want to disable sidebar in current folder, add [currentFolderRoute]: false in sidebar config.
-
If you want to tell theme that you only want sidebar in routes you set, add [rootLocalePath]: false in sidebar config to tell theme sidebar config is disabled by default.
In order to speed up the installation of themes and plugins, we set dependencies with large size as optional, which means that when features you use require these dependencies, you need to manually install the corresponding dependencies.
-
Just install them in your project directly through your current package manager:
If you are facing error like this, you are probably using non-standard tags in your project.
-
There are tags like <center> or <font>, which is in HTML1.0 spec, but marked as unrecommended since HTML4.0 released in 1999, then removed in HTML5 release in 2008. So Vue is not allowing you to use them by default. You should probably remove them and use standard HTML5 tag.
-
To remove them, run theme with --debug flag, and you will get warning logs telling you tags that probably not be recognized.
-
To use them anyway, check here to get a workaround.
This error indicates that you have an SSR mismatch, and it should not be a problem with theme.
-
Please check if you are using CloudFlare related services first, if so, make sure you turn off static resource compression. Visit dash.cloudflare.com, go to Websites → YOUR_DOMAIN → Speed → Optimization, turn JavaScript and HTML off in Auto Minify options.
-
-
Warning
-
Auto Minify in CloudFlare incorrectly handle HTML spaces and line breaks, which can cause Vue triggering SSR mismatches during initialization.
-
-
To debug this, set __VUE_PROD_HYDRATION_MISMATCH_DETAILS__ to true so that you can see the details of the mismatch in browser console.
-
If a component is likely to have different render results between SSR[1] and CSR[2]. You can wrap your components with the <ClientOnly /> component provided by vuepress/client.
Some configuration has high performance impact on dev server, so their hot reload are disabled by default. You can enable it manually via hotReload: true in theme options.
-
These include categories and tags for blog, structured sidebar and git-based information.
You can first review the documentation to see if the setting does not support page config.
-
Support for page config means that the theme allows the config of the page to override the global config of the same name (same function), but not all functions meet this setting.
-
-
Tips
-
You should be aware that some features will not be loaded during the prepare stage when the global setting is disabled, so they cannot be enabled locally.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.js
deleted file mode 100644
index fe7180c..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/common-question.html\",\"title\":\"Common question\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Common question\",\"order\":1,\"icon\":\"triangle-exclamation\",\"category\":[\"FAQ\"],\"description\":\"Adding Markdown Extensions You can use extendsMarkdown hook in to add Markdown extensions: Foldable Sidebar / TOC on Mobile / Left Sidebar on PC To better adapt to different siz...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/common-question.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/common-question.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/common-question.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Common question\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Adding Markdown Extensions You can use extendsMarkdown hook in to add Markdown extensions: Foldable Sidebar / TOC on Mobile / Left Sidebar on PC To better adapt to different siz...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Common question\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Adding Markdown Extensions\",\"slug\":\"adding-markdown-extensions\",\"link\":\"#adding-markdown-extensions\",\"children\":[]},{\"level\":2,\"title\":\"Foldable Sidebar / TOC on Mobile / Left Sidebar on PC\",\"slug\":\"foldable-sidebar-toc-on-mobile-left-sidebar-on-pc\",\"link\":\"#foldable-sidebar-toc-on-mobile-left-sidebar-on-pc\",\"children\":[]},{\"level\":2,\"title\":\"Display h4 or deeper level titles\",\"slug\":\"display-h4-or-deeper-level-titles\",\"link\":\"#display-h4-or-deeper-level-titles\",\"children\":[]},{\"level\":2,\"title\":\"Adjust content width\",\"slug\":\"adjust-content-width\",\"link\":\"#adjust-content-width\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.65,\"words\":496},\"filePathRelative\":\"faq/common-question.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.vue
deleted file mode 100644
index ba66a38..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/common-question.html.vue
+++ /dev/null
@@ -1,71 +0,0 @@
-
To better adapt to different sizes of devices, the theme uses responsive layout to adjust the layout according to the screen width.
-
Since the layout is pre-rendered, all sizes of screens share the same DOM structure. To correctly render FCP and for better performance, different size layouts are almost entirely rendered by CSS rather than controlling by scripts. We implement several sets of CSS to display different layouts with same DOM structure. This means that you cannot customize these layouts or adjust their order.
-
The only thing you can configure is the CSS breakpoint. The default breakpoints are as follows:
-
You can customize these breakpoints with style config file.
-
For example:
-
-
-
If you don't like the wide layout, you can set the $pc breakpoint to a very large value:
-
$pc: 9999px;
-
-
-
If you don't want the Pad layout, you can overlap the $tablet breakpoint and the $pad breakpoint:
-
$tablet: 959px;
-
-
-
Of course, if you are expect enough, you can achieve the layout you want by overriding the theme's CSS styles. This may be difficult, but it is technically feasible.
If you are not satisfied with the default content width, you can adjust the content width by setting the $content-width variable in the palette file.
-
-
Narrow content width
-
If you feel that the content width is very narrow, this is probably your personal aesthetic problem, because vuepress-theme-hope follows the best layout design practices. For related discussions and solutions to make the content fill the screen, see this discussion.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/index.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/index.html.js
deleted file mode 100644
index 5b17f29..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/index.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/\",\"title\":\"FAQ\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"FAQ\",\"icon\":\"circle-question\",\"star\":true,\"category\":[\"FAQ\"],\"description\":\"Frequency asked questions and corresponding solutions using the theme are included here. Catalog Contact Us Before contacting us, please make sure to check your project accordin...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"FAQ\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Frequency asked questions and corresponding solutions using the theme are included here. Catalog Contact Us Before contacting us, please make sure to check your project accordin...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"FAQ\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Catalog\",\"slug\":\"catalog\",\"link\":\"#catalog\",\"children\":[]},{\"level\":2,\"title\":\"Contact Us\",\"slug\":\"contact-us\",\"link\":\"#contact-us\",\"children\":[{\"level\":3,\"title\":\"Report a Problem\",\"slug\":\"report-a-problem\",\"link\":\"#report-a-problem\",\"children\":[]}]},{\"level\":2,\"title\":\"Getting Help\",\"slug\":\"getting-help\",\"link\":\"#getting-help\",\"children\":[]},{\"level\":2,\"title\":\"Social Group\",\"slug\":\"social-group\",\"link\":\"#social-group\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.63,\"words\":489},\"filePathRelative\":\"faq/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/index.html.vue
deleted file mode 100644
index b2bc6e3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/index.html.vue
+++ /dev/null
@@ -1,80 +0,0 @@
-
Frequency asked questions and corresponding solutions using the theme are included here.
If you have questions about learning and using Vue, TypeScript, Sass, or you don't know how to write what you want, you may want to ask questions on the Vue forums, Stack Overflow, etc.
-
-
-
If you have questions about VuePress, please open a new discussion in VuePress repo, as a member of the VuePress team, Mr.Hope will try to answer in his spare time.
-
-
-
Please only start discussions about the VuePress Theme Hope and plugins written by Mr.Hope in theme repository.
-
-
-
-
If you ran into some issues, please open a discussion on GitHub with:
-
-
full log running vuepress dev [docs-dir] --debug
-
error screenshot in browser console (if there are errors)
-
if your problem is related to display, please also provide related screenshots.
-
-
-
-
If there is something you don't know how to solve, welcome to open a discussion. Questions are always welcome, no matter they are simple or not. You only need to make sure three points:
-
-
-
You have tried searching related docs through search box.
-
-
-
You are providing a detailed description in the discussion.
-
-
If you don't know how to configure something, please describe what you want, and what you search or what section are you expecting to see the guidelines (so that we can improve our docs).
-
-
-
-
You are not asking question unrelated to VuePress or asking for a "technical support".
-
For customization, we only support "how can you customize something (in which way)". "How to customize something" (what you should write in your own codes) is NOT SUPPORTED. Unless you are donating this project, please do not insist asking help for that part.
-
Mr.Hope is a postgraduate student majored in theoretical physics, and really busy. He is not expecting to "be a doc provider" or "teach you how to write code".
The basic idea of a minimal reproduction is to use the least amount of both code and config to trigger missing or wrong behavior. Having a minimal reproduction makes it easier for the developers to see where the bug or missing feature is, and to verify that the new code satisfies requirements. ↩︎
-
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.js
deleted file mode 100644
index 349e68e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/safari.html\",\"title\":\"Safari FAQ\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Safari FAQ\",\"icon\":\"fab fa-safari\",\"order\":-1,\"category\":[\"FAQ\"],\"description\":\"Smooth Scrolling failed We use the CSS property scroll-behavior: smooth to provide smooth scrolling. It has a global approval rating of 93.06% [1] Currently, this property is on...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/safari.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/safari.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/safari.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Safari FAQ\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Smooth Scrolling failed We use the CSS property scroll-behavior: smooth to provide smooth scrolling. It has a global approval rating of 93.06% [1] Currently, this property is on...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Safari FAQ\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Smooth Scrolling failed\",\"slug\":\"smooth-scrolling-failed\",\"link\":\"#smooth-scrolling-failed\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.43,\"words\":129},\"filePathRelative\":\"faq/safari.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.vue
deleted file mode 100644
index 1d8da8b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/safari.html.vue
+++ /dev/null
@@ -1,16 +0,0 @@
-
We use the CSS property scroll-behavior: smooth to provide smooth scrolling. It has a global approval rating of 93.06% [1]
-
Currently, this property is only supported on iOS / iPadOS 15.4+ and macOS 12.3+[2].
-
If you need to use this feature in older versions of Safari, please refer to Related Stack Overflow Question to understand the reason and import smooth-scroll package to make polyfill by yourself.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.js
deleted file mode 100644
index 26e8810..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/troubleshooting.html\",\"title\":\"Troubleshooting\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Troubleshooting\",\"order\":2,\"icon\":\"square-check\",\"category\":[\"FAQ\"],\"description\":\"Ensure running under correct environment vuepress-theme-hope only supports node version of >=18.16.0. If the output of node -v does not satisfy the requirement, you should . Als...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/troubleshooting.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/troubleshooting.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/troubleshooting.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Troubleshooting\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Ensure running under correct environment vuepress-theme-hope only supports node version of >=18.16.0. If the output of node -v does not satisfy the requirement, you should . Als...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Troubleshooting\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Ensure running under correct environment\",\"slug\":\"ensure-running-under-correct-environment\",\"link\":\"#ensure-running-under-correct-environment\",\"children\":[]},{\"level\":2,\"title\":\"Ensure using the latest version and having correct deps tree\",\"slug\":\"ensure-using-the-latest-version-and-having-correct-deps-tree\",\"link\":\"#ensure-using-the-latest-version-and-having-correct-deps-tree\",\"children\":[]},{\"level\":2,\"title\":\"Ensure having correct config\",\"slug\":\"ensure-having-correct-config\",\"link\":\"#ensure-having-correct-config\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1,\"words\":299},\"filePathRelative\":\"faq/troubleshooting.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.vue
deleted file mode 100644
index 583f50d..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/troubleshooting.html.vue
+++ /dev/null
@@ -1,46 +0,0 @@
-
Please make sure you are using the latest vuepress, VuePress plugins and vuepress-theme-hope V2 version, because some bugs you encountered may have been fixed in new versions. Also in some cases, you may generate incorrect dependency tree after upgrading some dependencies. To let VuePress work correctly, there should only be one version of vue and vuepress in the whole project. Multiple versions of a package can cause different parts of the application to use different package, resulting in errors like useXXX() is called without provider.
-
You can execute the following command to make sure you are using the latest version and having correct deps tree.
Please confirm that there are no errors in your config file (such as red wavy lines), if so, please modify the config file according to the prompts until you correctly configured VuePress and themes.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.js b/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.js
deleted file mode 100644
index 614122f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.vue"
-const data = JSON.parse("{\"path\":\"/faq/vite.html\",\"title\":\"Vite FAQ\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Vite FAQ\",\"icon\":\"circle-question\",\"order\":-2,\"category\":[\"FAQ\"],\"description\":\"Running error Vite only supports \\\"modern browsers\\\" by default, see Vite support for details. Slow in a cold boot with Vite This is the expected behavior. We are adding more feat...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/faq/vite.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/faq/vite.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/faq/vite.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Vite FAQ\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Running error Vite only supports \\\"modern browsers\\\" by default, see Vite support for details. Slow in a cold boot with Vite This is the expected behavior. We are adding more feat...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Vite FAQ\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Running error\",\"slug\":\"running-error\",\"link\":\"#running-error\",\"children\":[]},{\"level\":2,\"title\":\"Slow in a cold boot with Vite\",\"slug\":\"slow-in-a-cold-boot-with-vite\",\"link\":\"#slow-in-a-cold-boot-with-vite\",\"children\":[]},{\"level\":2,\"title\":\"@import() in CSS does not work\",\"slug\":\"import-in-css-does-not-work\",\"link\":\"#import-in-css-does-not-work\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.4,\"words\":720},\"filePathRelative\":\"faq/vite.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.vue b/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.vue
deleted file mode 100644
index f53e962..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/faq/vite.html.vue
+++ /dev/null
@@ -1,107 +0,0 @@
-
This is the expected behavior. We are adding more features, which means we have 2× to 8× lines of code comparing with @vuepress/theme-default according to the functions you are using. So transforming and sending the theme and plugins code to browser is expected to increase from 0.8s - 2s in @vuepress/theme-default to 3s - 10s (range due to machine performance).
-
-
Tree-shaking burden
-
In order to fully support Tree-shaking in functionality and styles, themes and plugins do additional work, including modularization, partial injection, generation of temp files, etc. These extra behaviors ensure that unused feature code is removed at build stage, but it also means that more logic needs to be performed, and more fragmented files need to be loaded in development mode.
-
Dude, you can't expect to have the full power of tree-shaking support and still be extremely fast when the development server starts up, they are contradictory.
-
-
-
style system
-
In order to make component styles binding with component, we split the styles according to the component hierarchy and imported them in components, which greatly slowed down the speed.
-
-
-
@vuepress/theme-default is placing all the styles together at styles folder and importing them entirely, so that sass will only need to compile once and vite only need to send 1 extra web request. That's why it's fast.
-
But this will let style unbind with components, and they will be injected anyway. So that when you override a component or a layout, you have to override old styles to build styles you want.
-
-
-
vuepress-theme-hope is binding styles with components, but that means sass has to compile styles for each component, and vite need to send an extra request for each component. Due to vuepress-theme-hope has 2× to 6× components (depending on whether you enable blog features or not) comparing with @vuepress/theme-default, it will take extra time of 2.4s - 4s for that.
-
But, you can easily override a component together with its styles in this way.
-
-
-
So, due to the above reasons, vuepress-theme-hope will have an average of 4× code and 10× requests comparing with @vuepress/theme-default, so the time increasing from 2s to 10s is reasonable and expected.
-
-
-
No effect on HMR and online speed
-
don't worry, the above extra overhead mainly exists in code boot. Due to the large size of code in development environment, the corresponding time will also increase after refreshing.
-
-
-
These extra overheads do not affect HMR, so when editing the Markdown file, the page's HMR response can still remain at the 100 ms level.
-
-
-
Unused code twill be removed during the build phase with well design, so the production environment usually only adds additional 200 KB - 500 KB size in JS entry comparing the default theme and about 100 ms of extra script execution time, so the online impact is very small.
In VuePress2, importing web CSS via @import in index.scss has no effect. You may need to manually import it in the head option of your VuePress configuration.
If you need to upgrade your theme and VuePress version, execute the following command:
-
-pnpm
-yarn
-npm
-
-
pnpm dlx vp-update
-
-
-
yarn dlx vp-update
-
-
-
npx vp-update
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/get-started/config.html.js b/docs/theme/src/.vuepress/.temp/pages/get-started/config.html.js
deleted file mode 100644
index 0fba26f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/get-started/config.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/get-started/config.html.vue"
-const data = JSON.parse("{\"path\":\"/get-started/config.html\",\"title\":\"Project Config\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Project Config\",\"icon\":\"gears\",\"order\":5,\"category\":[\"Cookbook\",\"Tutorial\",\"Get Started\"],\"tag\":[\"Project Config\"],\"description\":\"This tutorial guides you on how to configure a VuePress project.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/get-started/config.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/get-started/config.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/get-started/config.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Project Config\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial guides you on how to configure a VuePress project.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Project Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Project Config\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Configure VuePress\",\"slug\":\"configure-vuepress\",\"link\":\"#configure-vuepress\",\"children\":[]},{\"level\":2,\"title\":\"Config File\",\"slug\":\"config-file\",\"link\":\"#config-file\",\"children\":[]},{\"level\":2,\"title\":\"Config Scope\",\"slug\":\"config-scope\",\"link\":\"#config-scope\",\"children\":[{\"level\":3,\"title\":\"Site Config\",\"slug\":\"site-config\",\"link\":\"#site-config\",\"children\":[]},{\"level\":3,\"title\":\"Theme Config\",\"slug\":\"theme-config\",\"link\":\"#theme-config\",\"children\":[]},{\"level\":3,\"title\":\"More\",\"slug\":\"more\",\"link\":\"#more\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.16,\"words\":649},\"filePathRelative\":\"get-started/config.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial guides you on how to configure a VuePress project.
VuePress uses .vuepress folder inside the docs folder to store configuration, and all VuePress related files will be placed here.
-
For a VuePress site, .vuepress/config.ts (or .vuepress/config.js) is the necessary config file.
-
-
Use TS configuration file
-
We recommend you to use TypeScript config files for better type hinting, autocompletion and error checking.
-
If you are not familiar with TypeScript, you can also use a JavaScript config file, but it is better to use an editor such as VSCode that fully supports TS/JS features to avoid losing the type checking, autocompletion and option hints features mentioned below.
You need to set up a config object in the config file .vuepress/config.ts (or .vuepress/config.js) and export it.
-
To get correct hints, importing defineUserConfig from vuepress and wrapping the config object is recommended:
-
-TS
-JS
-
-
import { defineUserConfig } from "vuepress";
-
-export default defineUserConfig({
- // put your config here
-});
-
-
-
import { defineUserConfig } from "vuepress";
-
-export default defineUserConfig({
- // put your config here
-});
-
-
-
In the template, in order to avoid the configuration file being too long, we use the ESM feature natively provided by JavaScript to split the theme configuration, navigation bar and sidebar configuration into separate files.
-
The template extracts theme functions to .vuepress/theme.js and exports them via export default.
-
.vuepress/theme.ts:
-
import { hopeTheme } from "vuepress-theme-hope";
-
-// We export the theme object by default
-export default hopeTheme({
- // theme configuration
-});
-
Then import directly in the configuration file:
-
.vuepress/config.ts:
-
//...
-// we introduce the theme here
-import theme from "./theme.js";
-
-//...
-
-export default defineUserConfig({
- //...
-
- // This is equivalent to `theme: hopeTheme({/* your config */})`
- theme,
-
- //...
-});
-
This can also help you understand the site configuration and theme configuration in the configuration more clearly.
VuePress Theme Hope bundles some plugins, you can pass plugin options through plugins.PLUGIN_NAME in theme options, see Config → Theme Plugin for more details.
-
If you want to use additional plugins, please import the plugin yourself and pass plugin options, see VuePress → plugins for details.
-
-
-
Style Config
-
VuePress Theme Hope is using .vuepress/styles folder to store style config like other themes.
-
In this folder you can:
-
-
Create index.scss to inject additional CSS styles
-
Create config.scss for styling config
-
Create palette.scss to set color and layout
-
-
For more details, see Config → Style.
-
-
-
Page Config
-
VuePress supports page scope config of specific page through YAML Frontmatter in Markdown files. For details, see Project Content → Frontmatter in the previous chapter.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/get-started/content.html.js b/docs/theme/src/.vuepress/.temp/pages/get-started/content.html.js
deleted file mode 100644
index 1870ea4..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/get-started/content.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/get-started/content.html.vue"
-const data = JSON.parse("{\"path\":\"/get-started/content.html\",\"title\":\"Project Content\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Project Content\",\"icon\":\"file\",\"order\":4,\"category\":[\"Cookbook\",\"Tutorial\",\"Get Started\"],\"tag\":[\"Project Content\"],\"description\":\"This tutorial guides you on how to generate page in a VuePress project.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/get-started/content.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/get-started/content.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/get-started/content.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Project Content\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial guides you on how to generate page in a VuePress project.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Project Content\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Project Content\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Generating Pages\",\"slug\":\"generating-pages\",\"link\":\"#generating-pages\",\"children\":[]},{\"level\":2,\"title\":\"Markdown\",\"slug\":\"markdown\",\"link\":\"#markdown\",\"children\":[]},{\"level\":2,\"title\":\"Frontmatter\",\"slug\":\"frontmatter\",\"link\":\"#frontmatter\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.37,\"words\":412},\"filePathRelative\":\"get-started/content.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial guides you on how to generate page in a VuePress project.
README.md is a special case. In Markdown, by convention, it will be used as the home page of the folder where it is located. So when it is rendered as a web page, its corresponding path is the home page path index.html in the web page.
Each Markdown file will be processed by VuePress Theme Hope to render file content as webpage content.
-
You can try editing the Markdown file yourself to modify the content of the template. If you have started the development server, the modified results will be synced to the development server in real time.
-
-
Markdown Syntax
-
If you don't know Markdown yet, check out the Markdown Tutorial.
-
In about fifteen minutes, you can learn how to write Markdown, remember to come back after reading it!
-
-
-
Markdown Extension
-
-
-
VuePress itself extends some Markdown syntax. For details, see VuePress → Markdown.
-
-
-
The theme additionally enables some syntax extensions via vuepress-plugin-md-enhance, see Guide → Markdown.
Frontmatter is an important concept in VuePress, it is used to carry config of Markdown files. Markdown files can contain a YAML Frontmatter.
-
Frontmatter must be at the top of the Markdown file, surrounded by a pair of triple dashes. Here is a basic example:
-
---
-lang: en-US
-title: the title of the page
-description: the description of the page
----
-
-<!-- Here is Markdown Content -->
-
-...
-
You may noticed that fields in demo Frontmatter are very similar to VuePress config file. You can override the lang, title, description and other properties of the current page through Frontmatter. Therefore, you can think of Frontmatter as a page-level scope config, which usually has the highest priority, and the config only takes effect on the current page.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/get-started/create.html.js b/docs/theme/src/.vuepress/.temp/pages/get-started/create.html.js
deleted file mode 100644
index 4ad8529..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/get-started/create.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/get-started/create.html.vue"
-const data = JSON.parse("{\"path\":\"/get-started/create.html\",\"title\":\"Create Project\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Create Project\",\"icon\":\"folder-plus\",\"order\":2,\"category\":[\"Cookbook\",\"Tutorial\",\"Get Started\"],\"tag\":[\"Template\"],\"description\":\"This tutorial will guide you through creating a VuePress Theme Hope project.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/get-started/create.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/get-started/create.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/get-started/create.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Create Project\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial will guide you through creating a VuePress Theme Hope project.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Template\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Create Project\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"1. Choose an Appropriate Location\",\"slug\":\"_1-choose-an-appropriate-location\",\"link\":\"#_1-choose-an-appropriate-location\",\"children\":[]},{\"level\":2,\"title\":\"2. Create Project template\",\"slug\":\"_2-create-project-template\",\"link\":\"#_2-create-project-template\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.83,\"words\":248},\"filePathRelative\":\"get-started/create.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial will guide you through creating a VuePress Theme Hope project.
To avoid accidentally triggering some strange problems that you cannot solve by yourself, please try to avoid using file paths that contain CJK characters, emoji or spaces (e.g. C:\Users\毛泽东\Desktop\VuePress Project\Hope theme ❤️\).
-
It is recommended to use plain English paths (e.g. D:\projects\vuepress-theme-hope\).
Please use file explorer to open that folder, then enter cmd in the address bar above and press Enter.
-
-
Execute one of the following command in terminal:
-
-pnpm
-yarn
-npm
-
-
pnpm create vuepress-theme-hope my-docs
-
-
-
yarn create vuepress-theme-hope my-docs
-
-
-
npm init vuepress-theme-hope@latest my-docs
-
-
-
-
Folder Argument
-
Here my-docs is an argument representing the folder name of the VuePress Theme Hope project. In this tutorial, we will generate the project to the my-docs folder in the current directory.
-
You can change this parameter to use a new folder if you want.
-
-
-
Dev Server
-
If you choose to start the development server after the template is initialized, you can enter localhost:8080/ in the browser address bar to access the development server after the dev server starts.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/get-started/deploy.html.js b/docs/theme/src/.vuepress/.temp/pages/get-started/deploy.html.js
deleted file mode 100644
index 3bf2296..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/get-started/deploy.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/get-started/deploy.html.vue"
-const data = JSON.parse("{\"path\":\"/get-started/deploy.html\",\"title\":\"Project Deployment\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Project Deployment\",\"icon\":\"rocket\",\"order\":7,\"category\":[\"Cookbook\",\"Tutorial\",\"Get Started\"],\"tag\":[\"Project Deployment\"],\"description\":\"This tutorial guides you on how to deploy a VuePress project.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/get-started/deploy.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/get-started/deploy.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/get-started/deploy.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Project Deployment\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial guides you on how to deploy a VuePress project.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Project Deployment\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Project Deployment\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Build Project\",\"slug\":\"build-project\",\"link\":\"#build-project\",\"children\":[]},{\"level\":2,\"title\":\"Deploy to GitHub Pages\",\"slug\":\"deploy-to-github-pages\",\"link\":\"#deploy-to-github-pages\",\"children\":[]},{\"level\":2,\"title\":\"Other deployment methods\",\"slug\":\"other-deployment-methods\",\"link\":\"#other-deployment-methods\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.86,\"words\":259},\"filePathRelative\":\"get-started/deploy.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial guides you on how to deploy a VuePress project.
Once you completed the starter stage development of the project locally, you can build the website using the pnpm docs:build command.
-
If you are using theme template, the website content will be output to the .vuepress/dist under VuePress project folder These files are the final output of VuePress.
-
You can deploy the contents of this folder to your website's server. The easiest way to do this is to upload to GitHub and start GitHub Pages.
-
After the action finishes, you should go to GitHub repo settings to choose gh-pages as source of GitHub Pages.
If you're using theme template, and you choose to create GitHub workflow during setup, the only thing you need to do is set the correct base option.
-
-
-
If you are going to publish to https://<USERNAME>.github.io/, you must upload the entire project to the https://github.com/<USERNAME>/<USERNAME>.github.io repository. You don't need to make any changes in this case, since base defaults to "/".
-
-
-
If your repository link is in a normal format like https://github.com/<USERNAME>/<REPO>, the website will be published to https://<USERNAME>.github.io /<REPO>/, so you need to set base to "/<REPO>/".
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/get-started/env.html.js b/docs/theme/src/.vuepress/.temp/pages/get-started/env.html.js
deleted file mode 100644
index 3b1604e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/get-started/env.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/get-started/env.html.vue"
-const data = JSON.parse("{\"path\":\"/get-started/env.html\",\"title\":\"Runtime Setup\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Runtime Setup\",\"icon\":\"leaf\",\"order\":1,\"category\":[\"Cookbook\",\"Tutorial\",\"Get Started\"],\"tag\":[\"Runtime\"],\"description\":\"This tutorial will guide you on how to set up a VuePress runtime environment.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/get-started/env.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/get-started/env.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Runtime Setup\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial will guide you on how to set up a VuePress runtime environment.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Runtime\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Runtime Setup\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Editor\",\"slug\":\"editor\",\"link\":\"#editor\",\"children\":[]},{\"level\":2,\"title\":\"Node.js\",\"slug\":\"node-js\",\"link\":\"#node-js\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.95,\"words\":285},\"filePathRelative\":\"get-started/env.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial will guide you on how to set up a VuePress runtime environment.
VuePress only controls the files in the VuePress project folder, that is, the parameters in the previous chapter. Other files in project are not used by VuePress.
-
-
Note
-
If you used docs as instructed in the previous tutorial, then docs is your VuePress project folder.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/client.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/client.html.js
deleted file mode 100644
index 61178cc..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/client.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/client.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/client.html\",\"title\":\"Client Config file\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Client Config file\",\"icon\":\"gears\",\"order\":-3,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"Client Config\"],\"description\":\"You can create .vuepress/client.ts or .vuepress/client.js as a client config file to customize your site.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/client.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/client.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/client.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Client Config file\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can create .vuepress/client.ts or .vuepress/client.js as a client config file to customize your site.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Client Config\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Client Config file\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Example\",\"slug\":\"example\",\"link\":\"#example\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.49,\"words\":146},\"filePathRelative\":\"guide/advanced/client.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
You can create .vuepress/client.ts or .vuepress/client.js as a client config file to customize your site.
import { defineClientConfig } from "vuepress/client";
-import ExampleGlobalComponent from "./components/ExampleGlobalComponent.vue";
-import ExampleRootComponent from "./components/ExampleRootComponent.vue";
-import { setupExampleCompositionAPI } from "./composables/exampleCompositionAPI";
-import ExampleLayout from "./layouts/ExampleLayout.vue";
-
-export default defineClientConfig({
- // Client enhancements
- enhance: ({ app, router }) => {
- // register global component
- app.component("ExampleGlobalComponent", ExampleGlobalComponent);
-
- // register router guard
- router.beforeEach((to) => {
- console.log("before navigation");
- });
-
- router.afterEach((to) => {
- console.log("after navigation");
- });
- },
-
- // global registration
- setup() {
- // Register the global Composition API
- setupExampleCompositionAPI();
-
- // access dom in client
- onMounted(() => {
- // use DOM API after mounted
- document.querySelector("#app");
- });
- },
-
- // adding or overriding layouts
- layouts: {
- ExampleLayout,
- },
-
- // global component
- rootComponents: [
- "ExampleRootComponent",
- //...
- ],
-});
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.js
deleted file mode 100644
index 9598cbf..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/extend.html\",\"title\":\"Theme Extending\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Extending\",\"icon\":\"clone\",\"order\":-1,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"Customize\"],\"description\":\"vuepress-theme-hope supports extending just like @vuepress/theme-default. You can create your own theme based on vuepress-theme-hope and use it locally or publish it according t...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/extend.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/extend.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/extend.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Extending\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope supports extending just like @vuepress/theme-default. You can create your own theme based on vuepress-theme-hope and use it locally or publish it according t...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Extending\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"How to Extend Theme Hope\",\"slug\":\"how-to-extend-theme-hope\",\"link\":\"#how-to-extend-theme-hope\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.01,\"words\":304},\"filePathRelative\":\"guide/advanced/extend.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.vue
deleted file mode 100644
index 4933244..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/extend.html.vue
+++ /dev/null
@@ -1,91 +0,0 @@
-
vuepress-theme-hope supports extending just like @vuepress/theme-default.
-
You can create your own theme based on vuepress-theme-hope and use it locally or publish it according to your needs.
You need to create an entry file for your theme and import hopeTheme from vuepress-theme-hope.
-
In your entry file, set extends: hopeTheme(options) to extend the vuepress-theme-hope theme.
-
The aliases of the same name (alias) and layouts (layouts) of your own newly created theme has higher priority over the extended theme vuepress-theme-hope, which means that you can override vuepress-theme-hope components via alias option in theme api, and you can add or override layouts via layouts in client config file.
-
-TS
-JS
-
-
import { getDirname, path } from "vuepress/utils";
-import { hopeTheme } from "vuepress-theme-hope";
-import type { ThemeOptions } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default (options: ThemeOptions) => ({
- name: "vuepress-theme-local",
-
- extends: hopeTheme(options, { custom: true }),
-
- alias: {
- // You can override or add aliases here
- // For example, here we change the vuepress-theme-hope HomePage component to components/HomePage.vue under our own theme
- "@theme-hope/components/HomePage": path.resolve(
- __dirname,
- "./components/HomePage.vue",
- ),
- },
-});
-
-
-
import { getDirname, path } from "vuepress/utils";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default (options) => ({
- name: "vuepress-theme-local",
-
- extends: hopeTheme(options, { custom: true }),
-
- alias: {
- // You can override or add aliases here
- // For example, here we change the vuepress-theme-hope HomePage component to components/HomePage.vue under our own theme
- "@theme-hope/components/HomePage": path.resolve(
- __dirname,
- "./components/HomePage.vue",
- ),
- },
-});
-
-
-
Also, you can add or override layout provided by vuepress-theme-hope via layouts in your theme client config file.
-
-TS
-JS
-
-
import { defineClientConfig } from "vuepress/client";
-import Changelog from "./layouts/Changelog.vue";
-import Layout from "./layouts/Layout.vue";
-
-export default defineClientConfig({
- // You can override or add layouts here
- layouts: {
- // For example, here we change the default layout of vuepress-theme-hope to layouts/Layout.vue
- Layout,
- // Also we added a Changelog layout
- Changelog,
- },
-});
-
-
-
import { defineClientConfig } from "vuepress/client";
-import Changelog from "./layouts/Changelog.vue";
-import Layout from "./layouts/Layout.vue";
-
-export default defineClientConfig({
- // You can override or add layouts here
- layouts: {
- // For example, here we change the default layout of vuepress-theme-hope to layouts/Layout.vue
- Layout,
- // Also we added a Changelog layout
- Changelog,
- },
-});
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/feed.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/feed.html.js
deleted file mode 100644
index aa27748..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/feed.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/feed.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/feed.html\",\"title\":\"Feed Support\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Feed Support\",\"icon\":\"rss\",\"order\":4,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"Feed\"],\"description\":\"The theme adds feed support with [@vuepress/plugin-feed][feed]. To use it, install @vuepress/plugin-feed manually in your project. Info vuepress-theme-hope provides plugins.feed...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/feed.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/feed.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/feed.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Feed Support\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme adds feed support with [@vuepress/plugin-feed][feed]. To use it, install @vuepress/plugin-feed manually in your project. Info vuepress-theme-hope provides plugins.feed...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feed\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Feed Support\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Enable Feed Output\",\"slug\":\"enable-feed-output\",\"link\":\"#enable-feed-output\",\"children\":[]},{\"level\":2,\"title\":\"Channel Settings\",\"slug\":\"channel-settings\",\"link\":\"#channel-settings\",\"children\":[]},{\"level\":2,\"title\":\"Generation Control\",\"slug\":\"generation-control\",\"link\":\"#generation-control\",\"children\":[{\"level\":3,\"title\":\"I18n Config\",\"slug\":\"i18n-config\",\"link\":\"#i18n-config\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.25,\"words\":375},\"filePathRelative\":\"guide/advanced/feed.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme adds feed support with [@vuepress/plugin-feed][feed]. To use it, install @vuepress/plugin-feed manually in your project.
\\n
\\n
Info
\\n
vuepress-theme-hope provides plugins.feed in theme options to @vuepress/plugin-feed.
The @vuepress/plugin-feed plugin can generate feed files in the following three formats for you:
-
-
Atom 1.0
-
JSON 1.1
-
RSS 2.0
-
-
-
Please use RSS if possible. Atom and JSON are only provided for best compatibility.
-
-
Please set plugins.feed.atom, plugins.feed.json or plugins.feed.rss to true in theme options according to the format you want to generate.
-
-
Tips
-
Of course, you can enable them all. This is not a "choose 1 from 3" situation.
-
-
Considering that rare people stick to feed now, this plugin provides a minimal configuration to adjust the automatic generation of detailed feed files. Also, it allows you to freely define the output content of the feed.
The plugin generates separate feeds for each language.
-
You can provide different settings for different languages via plugins.feed.locales.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.js
deleted file mode 100644
index 8b84ed3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/\",\"title\":\"Advanced\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Advanced\",\"icon\":\"gem\",\"index\":false,\"dir\":{\"order\":9},\"category\":[\"Advanced\"],\"tag\":[\"Advanced\"],\"description\":\"Here are some advanced uses of vuepress-theme-hope. To properly use them the way you want, you should understand of how VuePress works, know about VuePress Plugin API, or relate...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Here are some advanced uses of vuepress-theme-hope. To properly use them the way you want, you should understand of how VuePress works, know about VuePress Plugin API, or relate...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Advanced\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.76,\"words\":229},\"filePathRelative\":\"guide/advanced/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.vue
deleted file mode 100644
index 36c4e2c..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/index.html.vue
+++ /dev/null
@@ -1,20 +0,0 @@
-
Here are some advanced uses of vuepress-theme-hope.
-
To properly use them the way you want, you should understand of how VuePress works, know about VuePress Plugin API, or related concepts.
-
If you are new to frontend, you can give up these features at your discretion.
-
-
Warning
-
To be as friendly as possible to newcomers, we added concept introductions that are important in the corresponding chapters of the document as much as possible.
-
If you are still confused what's it or what's it for after reading, we recommend you to learn through the internet or stop using those features.
-
We are happy to answer your questions about how to customize related content. Also, if you do want to implement XXX, but don't know how, we are happy to give you advice on what you should learn to implement them.
-
But please don't ask such questions:
-
-
What is XXX?
-
What does XXX do, why do we need it?
-
Here is something I wrote, it's throwing errors/ not working as I am expecting, how to fix it?
-
...
-
-
We do not want to "describe all the concepts involved and their usage to you" and "teach you how to implement the features you want" in telegram group or discussion panel.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/pwa.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/pwa.html.js
deleted file mode 100644
index 724189b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/pwa.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/pwa.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/pwa.html\",\"title\":\"PWA\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"PWA\",\"icon\":\"mobile-screen\",\"order\":3,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"PWA\"],\"description\":\"The theme provides progressive web app support [^pwa-intro] via [@vuepress/plugin-pwa][pwa]. To use it, install @vuepress/plugin-pwa manually in your project. Info If you are us...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/pwa.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/pwa.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/pwa.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"PWA\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme provides progressive web app support [^pwa-intro] via [@vuepress/plugin-pwa][pwa]. To use it, install @vuepress/plugin-pwa manually in your project. Info If you are us...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"PWA\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"PWA\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Direct Enable\",\"slug\":\"direct-enable\",\"link\":\"#direct-enable\",\"children\":[]},{\"level\":2,\"title\":\"Web App Manifests\",\"slug\":\"web-app-manifests\",\"link\":\"#web-app-manifests\",\"children\":[]},{\"level\":2,\"title\":\"Cache Control\",\"slug\":\"cache-control\",\"link\":\"#cache-control\",\"children\":[{\"level\":3,\"title\":\"Default cache\",\"slug\":\"default-cache\",\"link\":\"#default-cache\",\"children\":[]},{\"level\":3,\"title\":\"Image Cache\",\"slug\":\"image-cache\",\"link\":\"#image-cache\",\"children\":[]},{\"level\":3,\"title\":\"HTML Cache\",\"slug\":\"html-cache\",\"link\":\"#html-cache\",\"children\":[]},{\"level\":3,\"title\":\"Size Control\",\"slug\":\"size-control\",\"link\":\"#size-control\",\"children\":[]}]},{\"level\":2,\"title\":\"Update Control\",\"slug\":\"update-control\",\"link\":\"#update-control\",\"children\":[{\"level\":3,\"title\":\"Popups\",\"slug\":\"popups\",\"link\":\"#popups\",\"children\":[]}]},{\"level\":2,\"title\":\"Other Options\",\"slug\":\"other-options\",\"link\":\"#other-options\",\"children\":[]},{\"level\":2,\"title\":\"Further Reading\",\"slug\":\"further-reading\",\"link\":\"#further-reading\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":4.74,\"words\":1423},\"filePathRelative\":\"guide/advanced/pwa.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme provides progressive web app support [^pwa-intro] via [@vuepress/plugin-pwa][pwa]. To use it, install @vuepress/plugin-pwa manually in your project.
\\n
\\n
Info
\\n
If you are using this plugin, we recommend you to set shouldPrefetch: false in your VuePress config file.
\\n
vuepress-theme-hope provides plugins.pwa in theme options to @vuepress/plugin-pwa.
You can set plugins.pwa to true in theme options to let theme automatically generate the necessary config and enable plugins quickly. However, we recommend you to manually set some options by following the instructions below.
To make your website fully compliant with PWA, a Web app manifests [2] file is needed, and your pwa should satisfy the installability [3] specification.
-
You can set plugins.pwa.manifest option to customize the manifest file, or provide a manifest.webmanifest or manifest.json in public folder. The former has higher priority.
-
The plugin will automatically generate manifest.webmanifest for you and add manifest link declaration in each page, while you should still at least set a valid icon through plugins.pwa.manifest.icons or other icon related options in the PWA plugin.
-
-
Warning
-
The installability [3:1] specification requires at least one valid icon to be declared in the manifest.
-
So if you do not configure plugins.pwa.manifest.icons, visitors can only enjoy the offline accessibility brought by the Service Worker cache, while cannot install your site as a PWA.
-
-
Besides the plugin does not process anything in the manifest by default, but outputs them as-is. This means that if you plan to deploy to a subdirectory, you should append the URL prefix to manifest Urls yourself. If everything you need is all under base directory, you can set plugins.pwa.appendBase: true in plugin options to let the plugin append base to any links in manifest.
By default, the plugin will pre-cache all jscss files, and only homepage and 404 html are cached. The plugin will also cache font files (woff, woff2, eot, ttf, otf) and SVG icons.
If your site has only a few important images, and want them displayed in offline mode, you can cache site images by setting plugins.pwa.cacheImage: true .
-
We recognize images by file extension. Any files ending with .png, .jpg, .jpeg, .gif, .bmp, .webp will be regarded as images.
If you have small sites, and would like to make document fully offline available, you can set plugins.pwa.cacheHTML to true to cache all HTML files.
-
-
Why only home and 404 page been cached by default?
-
Though VuePress generates HTML files through SSG[4] for all pages, these files are mainly used for SEO[5] and allow you to directly configure the backend without SPA[6] Visit any link.
-
VuePress is essentially an SPA. This means that you only need to cache the home page and enter from the home page to access all pages normally. Therefore, not caching other HTML by default can effectively reduce the cache size (40% smaller in size) and speed up the SW update speed.
-
But this also has the disadvantage. If the user enters the site directly from a non-home page, the HTML file for the first page still needs to be loaded from the internet. Also, in offline environment, users can only enter through the homepage and then navigate to the corresponding page by themselves. If they directly access a link, an inaccessible prompt will appear.
To prevent large files from being included in the pre-cache list, any files > 2 MB or images > 1 MB will be omitted. You can customize these limits with plugins.pwa.maxSize and plugins.pwa.maxImageSize options (in KB unit).
We provide the plugins.pwa.update option to control how users receive updates.
-
The default value of the plugins.pwa.update option is "available", which means that when new content available, the new SW will be installed and its resources will be fetched silently in the background. A pop-up window appears once the new SW is ready, and users can choose whether to refresh immediately to view new content. This means users are reading old content before a new SW is ready.
-
If your project is still in building stage, and you want to alert the user that he may be reading outdated content, you can set this to "hint". This allows users to be notified that new content has been published within seconds after visiting docs. But the negative effect of this is that if the user chooses to update before the new SW is ready, he will need to get all the resources of the page from the internet before the new SW installs and controls the page.
-
If your docs are stable, or you're hosting a blog and don't care much about users receiving the latest version right away, you can set this to "disabled", which means that the new SW will be installed completely silently in the background and start waiting, when all pages controlled by old SW are all closed, the new SW will start to take control and provide users with new content during next visit. This setting can prevent users from being disturbed during the visit.
-
To speed up user access under weak or no network conditions through SW, but also want users to always access new content, you can set this option to "force". This means any old SW will be removed as soon as a new SW is detected, and all pages are refreshed to ensure the user is browsing the latest content. The biggest disadvantage is that all users will experience unexpected sudden refresh within seconds after reentering an updated site.
When new content is detected (new SW detected), a update found popup appears; and when the new content is ready, an update ready popup appears.
-
If you are not satisfied with the default popup content, you can use your own component. Import PWAFoundPopup or PWAReadyPopup from @vuepress/plugin-pwa/client and use its slot to customize the popup content, then pass the component path to plugins.pwa.foundComponent or plugins.pwa.readyComponent option:
The plugin also provides other PWA-related options, such as Microsoft tile icon and color settings, Apple icon and so on. If you are an advanced user, you can also set plugins.pwa.generateSwConfig to configure workbox-build. Check Plugin options for more details.
PWA, full name Progressive Web app. PWA standard is stipulated by W3C.
-
It allows sites to install the site as an App on supported platform through a browser that supports this feature. ↩︎
-
-
Manifest File
-
The manifest file uses the JSON format and is responsible for declaring various information of the PWA, such as name, description, icon, and shortcut actions.
-
In order for your site to be registered as a PWA, you need to meet the basic specifications of the manifest to make the browser consider the site as an installable PWA and allow users to install it.
To let the site be registered as a PWA, the site needs to successfully register a valid service worker by itself, and declare a valid manifest file with its link in meta tag.
-
The manifest file should contain at least name (or short_name) iconsstart_url.
-
On safari, the maximum cache size of the service worker is 50 MB. ↩︎↩︎
SPA: Single Page Application, most of them only have the homepage, and use history mode to handle routing instead of actually navigating between pages. ↩︎
-
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/replace.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/replace.html.js
deleted file mode 100644
index 5bb8d5b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/replace.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/replace.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/replace.html\",\"title\":\"Replace Components\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Replace Components\",\"icon\":\"boxes-packing\",\"order\":-2,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"Customize\"],\"description\":\"When setting { custom: true } in Behavior options, the theme will import components through @theme-hope alias, so you can use it to replace any component of the theme.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/replace.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/replace.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/replace.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Replace Components\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"When setting { custom: true } in Behavior options, the theme will import components through @theme-hope alias, so you can use it to replace any component of the theme.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Replace Components\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"How to Replace via Alias\",\"slug\":\"how-to-replace-via-alias\",\"link\":\"#how-to-replace-via-alias\",\"children\":[]},{\"level\":2,\"title\":\"Using Slots\",\"slug\":\"using-slots\",\"link\":\"#using-slots\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.43,\"words\":1030},\"filePathRelative\":\"guide/advanced/replace.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
When setting { custom: true } in Behavior options, the theme will import components through @theme-hope alias, so you can use it to replace any component of the theme.
When setting { custom: true } in Behavior options, the theme will import components through @theme-hope alias, so you can use it to replace any component of the theme.
You need to replace the component alias used in the theme with alias option in your own VuePress config file.
-
-TS
-JS
-
-
import { getDirname, path } from "vuepress/utils";
-import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default defineUserConfig({
- theme: hopeTheme(
- {
- // your theme config here
- },
- { custom: true },
- ),
-
- alias: {
- // Here you can redirect aliases to your own components
- // For example, here we change the theme's home page component to HomePage.vue under user .vuepress/components
- "@theme-hope/components/HomePage": path.resolve(
- __dirname,
- "./components/HomePage.vue",
- ),
- },
-});
-
-
-
import { getDirname, path } from "vuepress/utils";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default {
- theme: hopeTheme(
- {
- // your theme config here
- },
- { custom: true },
- ),
-
- alias: {
- // Here you can redirect aliases to your own components
- // For example, here we change the theme's home page component to HomePage.vue under user .vuepress/components
- "@theme-hope/components/HomePage": path.resolve(
- __dirname,
- "./components/HomePage.vue",
- ),
- },
-};
-
Some components provide slots, in this case, you can directly import the original component when overriding the component, and pass in the content you need through the slot.
-
-
Tips
-
For demo of common slots, please refer Main Layout Slot demo。
-
-
For example, if your site has strong social attributes, and you want to display a comment box on the homepage, you can display it like this:
-
-config.ts
-HomePage.vue
-
-
import { getDirname, path } from "vuepress/utils";
-import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default defineUserConfig({
- theme: hopeTheme(
- {
- // your theme config here
- },
- { custom: true },
- ),
-
- alias: {
- // Here you can direct aliases to your own components
- // For example, here we change the theme's home page component to HomePage.vue under user .vuepress/components
- "@theme-hope/components/HomePage": path.resolve(
- __dirname,
- "./components/HomePage.vue",
- ),
- },
-});
-
For the corresponding location and function of each slot, please refer to theme source code.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/seo.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/seo.html.js
deleted file mode 100644
index 9f92dfd..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/seo.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/seo.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/seo.html\",\"title\":\"SEO\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"SEO\",\"icon\":\"dumbbell\",\"order\":1,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"SEO\"],\"description\":\"vuepress-theme-hope provides SEO enhancements via built-in [@vuepress/plugin-seo][seo]. To make the plugin work better, you may need to check the page config and configure them ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/seo.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/seo.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/seo.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"SEO\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope provides SEO enhancements via built-in [@vuepress/plugin-seo][seo]. To make the plugin work better, you may need to check the page config and configure them ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"SEO\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"SEO\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Out of Box\",\"slug\":\"out-of-box\",\"link\":\"#out-of-box\",\"children\":[{\"level\":3,\"title\":\"Default OGP Generation\",\"slug\":\"default-ogp-generation\",\"link\":\"#default-ogp-generation\",\"children\":[]},{\"level\":3,\"title\":\"Default JSON-LD Generation\",\"slug\":\"default-json-ld-generation\",\"link\":\"#default-json-ld-generation\",\"children\":[]}]},{\"level\":2,\"title\":\"Setting Tags Directly\",\"slug\":\"setting-tags-directly\",\"link\":\"#setting-tags-directly\",\"children\":[]},{\"level\":2,\"title\":\"Customize Generation\",\"slug\":\"customize-generation\",\"link\":\"#customize-generation\",\"children\":[{\"level\":3,\"title\":\"Page Type\",\"slug\":\"page-type\",\"link\":\"#page-type\",\"children\":[]},{\"level\":3,\"title\":\"OGP\",\"slug\":\"ogp\",\"link\":\"#ogp\",\"children\":[]},{\"level\":3,\"title\":\"JSON-LD\",\"slug\":\"json-ld\",\"link\":\"#json-ld\",\"children\":[]}]},{\"level\":2,\"title\":\"Canonical Link\",\"slug\":\"canonical-link\",\"link\":\"#canonical-link\",\"children\":[{\"level\":3,\"title\":\"Customize head Tags\",\"slug\":\"customize-head-tags\",\"link\":\"#customize-head-tags\",\"children\":[]}]},{\"level\":2,\"title\":\"RDFa 1.1\",\"slug\":\"rdfa-1-1\",\"link\":\"#rdfa-1-1\",\"children\":[]},{\"level\":2,\"title\":\"SEO Introduction\",\"slug\":\"seo-introduction\",\"link\":\"#seo-introduction\",\"children\":[]},{\"level\":2,\"title\":\"Related Documents\",\"slug\":\"related-documents\",\"link\":\"#related-documents\",\"children\":[]},{\"level\":2,\"title\":\"Related Tools\",\"slug\":\"related-tools\",\"link\":\"#related-tools\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.69,\"words\":1106},\"filePathRelative\":\"guide/advanced/seo.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope provides SEO enhancements via built-in [@vuepress/plugin-seo][seo].
\\n
To make the plugin work better, you may need to check the page config and configure them properly.
\\n
\\n
Info
\\n
vuepress-theme-hope passes plugins.seo in theme options as plugin options to @vuepress/plugin-seo.
The plugin works out of the box. Without any config, it will extract information from the page content as much as possible to complete the necessary tags required by OGP and JSON-LD.
-
By default, the plugin will read the site config and page frontmatter to automatically generate tags as much as possible. Such as site name, page title, page type, writing date, last update date, and article tags are all automatically generated.
-
The following are the <meta> tags and their values that will be injected into <head> by default:
For most pages, there are basically only two types: articles and website, so the plugin provides the isArticle option to allow you to provide logic for identifying articles.
-
The option accepts a function in the format (page: Page) => boolean, by default all non-home pages generated from Markdown files are treated as articles.
-
-
Note
-
If a page does fit into the "unpopular" genre like books, music, etc., you can handle them by setting the three options below.
For example, if you are using a third-party theme and set a banner in frontmatter for each article according to the theme requirements, then you can pass in the following ogp:
Like OGP, you can use plugins.seo.jsonLd options in theme options to pass in a function to modify the default JSON-LD object to your needs and return it.
If you are deploying your content to different sites, or same content under different URLs, you may need to set plugins.seo.canonical in theme options to provide a "Canonical Link" for your page. You can either set a string which will be prepended before page route link, or adding a custom function (page: Page) => string | null to return a canonical link if necessary.
-
-
Example
-
If your sites are deployed under docs folder in example.com, but available in:
-
-
http://example.com/docs/xxx
-
https://example.com/docs/xxx
-
http://www.example.com/docs/xxx
-
https://www.example.com/docs/xxx (primary)
-
-
To let search engine results always be the primary choice, you may need to set plugins.seo.canonical to https://www.example.com/docs/, so that search engine will know that the fourth URL is preferred to be indexed.
Sometimes you may need to fit other protocols or provide the corresponding SEO tags in the format provided by other search engines. In this case, you can use the plugins.seo.customHead in theme options, whose type is:
-
function customHead(
- /** Head tag config */
- head: HeadConfig[],
- /** Page Object */
- page: Page,
- /** VuePress App */
- app: App,
-): void;
-
You should modify the head array in this function directly.
Search engine optimization (SEO) is the process of improving the quality and quantity of site traffic to a site or a web page from search engines. SEO targets unpaid traffic (known as "natural" or "organic" results) rather than direct traffic or paid traffic. Unpaid traffic may originate from different kinds of searches, including image search, video search, academic search, news search, and industry-specific vertical search engines.
-
As an internet marketing strategy, SEO considers how search engines work, the computer-programmed algorithms that dictate search engine behavior, what people search for, the actual search terms or keywords typed into search engines, and which search engines are preferred by their targeted audience. SEO is performed because a site will receive more visitors from a search engine when sites rank higher on the search engine results page (SERP). These visitors can then potentially be converted into customers.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.js
deleted file mode 100644
index b707f98..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/advanced/sitemap.html\",\"title\":\"Sitemap\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Sitemap\",\"icon\":\"sitemap\",\"order\":2,\"category\":[\"Advanced\"],\"tag\":[\"Advanced\",\"Sitemap\"],\"description\":\"vuepress-theme-hope provide Sitemap generation with @vuepress/plugin-sitemap. The plugin will automatically generate the last update time of the page based on the Git timestamp ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/advanced/sitemap.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/advanced/sitemap.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/advanced/sitemap.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Sitemap\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope provide Sitemap generation with @vuepress/plugin-sitemap. The plugin will automatically generate the last update time of the page based on the Git timestamp ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Advanced\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Sitemap\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Sitemap\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Control Sitemap Link\",\"slug\":\"control-sitemap-link\",\"link\":\"#control-sitemap-link\",\"children\":[]},{\"level\":2,\"title\":\"Change Frequency\",\"slug\":\"change-frequency\",\"link\":\"#change-frequency\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.23,\"words\":369},\"filePathRelative\":\"guide/advanced/sitemap.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.vue
deleted file mode 100644
index b502515..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/advanced/sitemap.html.vue
+++ /dev/null
@@ -1,33 +0,0 @@
-
The plugin will automatically generate the last update time of the page based on the Git timestamp of the page, and will also declare the alternative version link of the page in other languages according to the locales' config.
-
If you don't need this plugin, please set plugins.sitemap to false in theme options.
-
-
Info
-
vuepress-theme-hope passes plugins.sitemap in theme options as plugin options to @vuepress/plugin-sitemap.
By default, all site links except 404 page will be added to the Sitemap.
-
To add other pages to the Sitemap outside the VuePress project page, please turn them into an array and pass to extraUrls.
-
If you don't want certain pages to appear in the sitemap, you can turn them into an array and pass them to excludeUrls, or you can pass in a filter function though filter options. You can also set sitemap.exclude to true in page frontmatter.
-
You can also control the output link through the sitemapFilename. The default output directory is sitemap.xml.
The default update cycle of the page is daily (every day). To modify the entire page cycle, please set changefreq. You can also set sitemap.changefreq in the frontmatter of the page. Note that page has a higher priority.
-
The legal frequencies are:
-
-
"always"
-
"hourly"
-
"daily"
-
"weekly"
-
"monthly"
-
"yearly"
-
"never"
-
-
-
Sitemap Intro
-
Sitemaps may be addressed to users or to software. Many sites have user-visible sitemaps which present a systematic view, typically hierarchical, of the site. These are intended to help visitors find specific pages, and can also be used by crawlers. Alphabetically organized site maps, sometimes called site indexes, are a different approach.
-
For use by search engines and other crawlers, there is a structured format, the XML Sitemap, which lists the pages in a site, their relative importance, and how often they are updated. This is pointed to from the robots.txt file and is typically called sitemap.xml.
-
Google introduced the Sitemaps protocol, so web developers can publish lists of links from across their sites.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/article.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/article.html.js
deleted file mode 100644
index ef9aa6a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/article.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/article.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/article.html\",\"title\":\"Article List\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Article List\",\"icon\":\"clipboard-list\",\"order\":3,\"category\":[\"Blog\"],\"tag\":[\"Article\",\"Blog\",\"Encrypt\",\"Slide\",\"Star\"],\"description\":\"The topic provides you with a list of all articles under the path /article/ by default. Article All articles will be added to the article list by default and rendered under the ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/article.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/article.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/article.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Article List\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The topic provides you with a list of all articles under the path /article/ by default. Article All articles will be added to the article list by default and rendered under the ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Article\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Encrypt\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Slide\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Star\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Article List\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Article\",\"slug\":\"article\",\"link\":\"#article\",\"children\":[]},{\"level\":2,\"title\":\"Excerpt\",\"slug\":\"excerpt\",\"link\":\"#excerpt\",\"children\":[{\"level\":3,\"title\":\"Adding Excerpt\",\"slug\":\"adding-excerpt\",\"link\":\"#adding-excerpt\",\"children\":[]},{\"level\":3,\"title\":\"Automatically Generate Excerpt\",\"slug\":\"automatically-generate-excerpt\",\"link\":\"#automatically-generate-excerpt\",\"children\":[]}]},{\"level\":2,\"title\":\"Star Articles\",\"slug\":\"star-articles\",\"link\":\"#star-articles\",\"children\":[]},{\"level\":2,\"title\":\"Other types of articles\",\"slug\":\"other-types-of-articles\",\"link\":\"#other-types-of-articles\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.4,\"words\":721},\"filePathRelative\":\"guide/blog/article.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The topic provides you with a list of all articles under the path /article/ by default.
\\n
Article
\\n
All articles will be added to the article list by default and rendered under the path /article/.
\\n
\\n
\\n
If you don't want the list to contain some specific articles, just set the article to false in the frontmatter of the article, or you may customize it through plugins.blog.filter in theme options.
\\n
To sticky a specific article in the article list, just set sticky to true in the frontmatter of the article.
\\n
\\n
Order
\\n
For sticky articles, you can set sticky with a number to set their order. Articles with large numbers will be listed first.
\\n
\\n
Excerpt
\\n
Adding Excerpt
\\n
If you want to add an excerpt for an article, you can mark contents with `
All articles will be added to the article list by default and rendered under the path /article/.
-
-
-
If you don't want the list to contain some specific articles, just set the article to false in the frontmatter of the article, or you may customize it through plugins.blog.filter in theme options.
-
To sticky a specific article in the article list, just set sticky to true in the frontmatter of the article.
-
-
Order
-
For sticky articles, you can set sticky with a number to set their order. Articles with large numbers will be listed first.
If you want to add an excerpt for an article, you can mark contents with <!-- more --> comment. Any content before this comment will be considered as an excerpt.
-
Meanwhile, if the excerpt you want to set is not what you want to show at the beginning of the article, you can also set the HTML string through the excerpt option in Frontmatter.
You can star an article by setting star to true in frontmatter. After staring, users can view these articles on the /star/ page.
-
At the same time, any star articles will be displayed in the article column on the sidebar of the blog homepage.
-
-
Info
-
Our consideration for providing star options: Theme users may want to show visitors some high-quality articles, but do not want sticky articles to flood the homepage, resulting in visitors not being able to see the recently updated articles.
-
-
-
Order
-
Similar to sticky articles, you can also set star to number to set their order. Articles with large numbers will be listed first.
The theme provides separate lists for additional article type.
-
To add additional article type, you should set plugins.blog.type in theme options with an array of objects describing type you want.
-
Each type should have a unique key (without special characters), and a filter function to determine whether a page should be the type. The filter function should accept page object and return a boolean value.
-
To sort pages in the type list, you can also set a sorter function. The sorter function should accept two page objects and return a number.
-
By default, the type list path will be /key/ (with key replaced by your actual key). You can also set a custom path by setting path in options.
-
frontmatter option controls the frontmatter of the layout page, with is a function accepting localePath and returning a frontmatter object. This option is useful when setting the title of the layout page.
-
-
Note
-
layout is the layout name, by default it will be BlogType, a layout vuepress-theme-hope registered. ONLY IF you build a custom layout for the type list, shall you set this option to your layout value.
-
-
Also, you need to set blogLocales[key] in theme locales with the actual type name, so that the theme can display the type name correctly.
-
To get start with, we would like to show you some examples.
-Examples
-
-
-
Adding a type of slide pages.
-
All slide pages should have layout: Slide in frontmatter. And the sequence doesn't matter.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/blogger.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/blogger.html.js
deleted file mode 100644
index 1098406..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/blogger.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/blogger.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/blogger.html\",\"title\":\"Blogger Info\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blogger Info\",\"icon\":\"circle-info\",\"order\":2,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Blogger\"],\"description\":\"Themes allow you to display basic information about the blogger.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/blogger.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/blogger.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/blogger.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blogger Info\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Themes allow you to display basic information about the blogger.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blogger\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blogger Info\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Avatar and blogger name\",\"slug\":\"avatar-and-blogger-name\",\"link\":\"#avatar-and-blogger-name\",\"children\":[]},{\"level\":2,\"title\":\"Motto, Social Media & Profile Link\",\"slug\":\"motto-social-media-profile-link\",\"link\":\"#motto-social-media-profile-link\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.46,\"words\":437},\"filePathRelative\":\"guide/blog/blogger.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Themes allow you to display basic information about the blogger.
You can use blog.description to set your own introduction, motto or slogan.
-
You can also specify a personal introduction page link through blog.intro, so when users click on the avatar and name, they will be direct to that page.
-
You can also config your social media links with blog.medias option.
-
-
-
If the social media icon is available below, you can set MediaName: MediaLink directly.
-
-
-
Otherwise, you should pass in a tuple MediaName: [MediaLink , MediaSvgIconString or MediaSvgIconPath],
-
The second element in the tuple must be a valid SVG string or a full path of an existing SVG file.
import { getDirname, path } from "vuepress/utils";
-import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default defineUserConfig({
- theme: hopeTheme({
- blog: {
- medias: {
- // GitHub Icon is available
- GitHub: "https://github.com/Mister-Hope",
- // A custom Media called "MediaX" (just an example)
- MediaX: [
- // link
- "https://mediax.com/UserX/",
- // icon string
- "<svg ....</svg>",
- ],
- // A custom Media called "MediaY" (just an example)
- MediaY: [
- // link
- "https://mediay.com/UserY/",
- // icon path
- path.resolve(__dirname, "icons/mediay.svg"),
- ],
- },
- },
- }),
-});
-
-
-
import { getDirname, path } from "vuepress/utils";
-import { hopeTheme } from "vuepress-theme-hope";
-
-const __dirname = getDirname(import.meta.url);
-
-export default {
- theme: hopeTheme({
- blog: {
- medias: {
- // GitHub Icon is available
- GitHub: "https://github.com/Mister-Hope",
- // A custom Media called "MediaX" (just an example)
- MediaX: [
- // link
- "https://mediax.com/UserX/",
- // icon string
- "<svg ....</svg>",
- ],
- // A custom Media called "MediaY" (just an example)
- MediaY: [
- // link
- "https://mediay.com/UserY/",
- // icon path
- path.resolve(__dirname, "icons/mediay.svg"),
- ],
- },
- },
- }),
-};
-
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/category-and-tags.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/category-and-tags.html.js
deleted file mode 100644
index bf4c2b3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/category-and-tags.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/category-and-tags.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/category-and-tags.html\",\"title\":\"Category and tags\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Category and tags\",\"icon\":\"tag\",\"order\":4,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Category\",\"Tag\"],\"description\":\"You can configure category and tags for articles through frontmatter to make them appear in specific categories and tags pages.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/category-and-tags.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/category-and-tags.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/category-and-tags.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Category and tags\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can configure category and tags for articles through frontmatter to make them appear in specific categories and tags pages.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Category\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Tag\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Category and tags\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Category Settings\",\"slug\":\"category-settings\",\"link\":\"#category-settings\",\"children\":[]},{\"level\":2,\"title\":\"Tags\",\"slug\":\"tags\",\"link\":\"#tags\",\"children\":[]},{\"level\":2,\"title\":\"View list\",\"slug\":\"view-list\",\"link\":\"#view-list\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.79,\"words\":238},\"filePathRelative\":\"guide/blog/category-and-tags.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
You can configure category and tags for articles through frontmatter to make them appear in specific categories and tags pages.
Just add category array to category in page frontmatter, the article will be automatically rendered in the list of the/category/<category name>/ category page.
-
For example, add this to a certain page:
-
---
-category:
- - HTML
- - Web
----
-
-Page content...
-
Then you can find it under the /category/html page.
Just set tag option in page frontmatter , and set value to one or more tags, then the article will be automatically rendered in the list of the /tag/<tag name>/ tag page.
-
For example, after adding this in frontmatter:
-
---
-tag:
- - HTML
- - Web
----
-
-Page content...
-
Then you can find it under the /tag/html and /tag/web pages.
Besides directly accessing the corresponding link, the category and tag name will be displayed at the article information at the top of the article. You can click on it to navigate to the corresponding list to view the articles of the same category or tag.
-Article Information
-
You can also select the category or tag tab in the sidebar of the blog homepage and select the corresponding item to enter the list.
-Sidebar Tab
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/home.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/home.html.js
deleted file mode 100644
index 6841a65..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/home.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/home.html\",\"title\":\"Blog homepage\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog homepage\",\"icon\":\"home\",\"order\":6,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Home\",\"Layout\"],\"description\":\"vuepress-theme-hope allows you to enable a blog-style and a portfolio style homepage.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog homepage\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope allows you to enable a blog-style and a portfolio style homepage.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Home\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog homepage\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Blog Style Homepage\",\"slug\":\"blog-style-homepage\",\"link\":\"#blog-style-homepage\",\"children\":[]},{\"level\":2,\"title\":\"Portfolio Style HomePage\",\"slug\":\"portfolio-style-homepage\",\"link\":\"#portfolio-style-homepage\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.47,\"words\":442},\"filePathRelative\":\"guide/blog/home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope allows you to enable a blog-style and a portfolio style homepage.
Set layout: BlogHome and home: true in the frontmatter of homepage.
-
-
-
You can use heroText to set the main title and tagline to set the subtitle.
-
If you have a logo, you can place it in the public folder and set it via heroImage, if you want to display another logo in night mode, you can use heroImageDark. For better A11y, we recommend that you set the description of Logo to heroAlt.
-
You can set the background image through bgImage and bgImageDark, but you need to pay attention that you must fill in the full URL or absolute path. If you want the information to be displayed in full screen, you can set heroFullScreen: true.
-
If you need to customize some styles, you can set the style of the logo and background image through heroImageStyle and bgImageStyle.
-
Typically, you might want to display some projects, books, articles, links, friend links, etc. on your homepage. You can set them via projects, which is an array where each element is an object with the following keys:
-
-
-
name: required, project name
-
-
-
link: required, project link, fill in an external path or absolute path
-
-
-
desc: project description
-
-
-
icon: Icon, you can fill in full path or absolute path image link, also icon FontClass is supported
-
We provide these icons as built-in support either: "link", "project", "book", "article", "friend"。
-
-
-
-
Info
-
For complete configuration items, see Blog Home Frontmatter Configuration.
Set layout: PortfolioHome and home: true in the frontmatter of homepage.
-
To describe yourself, set titles in frontmatter with titles that fits you.
-
You are expected to set a image of yours with avatar (and avatarDark for darkmode if needed). You can also set bgImage (and bgImageDark for darkmode if needed) to customize background image. Advanced style adjusting can be done with avatarStyle and bgImageStyle option.
-
The name is default to author option in theme options, while you can set name in frontmatter to customize it. The welcome message can also be customized through welcome option in frontmatter.
-
By default, media links set in blog.medias is displayed, while you can also set medias in frontmatter with nameicon and url for each media to override.
-
-
Living Demo
-
-
A portfolio demo
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.js
deleted file mode 100644
index c412d00..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/\",\"title\":\"Blog\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog\",\"icon\":\"blog\",\"index\":false,\"dir\":{\"order\":7},\"description\":\"Catalog\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Catalog\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Catalog\",\"slug\":\"catalog\",\"link\":\"#catalog\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.11,\"words\":33},\"filePathRelative\":\"guide/blog/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.vue
deleted file mode 100644
index a96142f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/index.html.vue
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/intro.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/intro.html.js
deleted file mode 100644
index fd79bb2..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/intro.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/intro.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/intro.html\",\"title\":\"Blog Intro\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog Intro\",\"icon\":\"blog\",\"order\":1,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Intro\"],\"description\":\"The theme supports blog feature with@vuepress/plugin-blog by default, and it's disabled by default. If you need blog functionality, you can set plugins.blog: true in theme optio...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/intro.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/intro.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/intro.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog Intro\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme supports blog feature with@vuepress/plugin-blog by default, and it's disabled by default. If you need blog functionality, you can set plugins.blog: true in theme optio...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog Intro\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Intro\",\"slug\":\"intro\",\"link\":\"#intro\",\"children\":[]},{\"level\":2,\"title\":\"I18n Support\",\"slug\":\"i18n-support\",\"link\":\"#i18n-support\",\"children\":[]},{\"level\":2,\"title\":\"Sidebar\",\"slug\":\"sidebar\",\"link\":\"#sidebar\",\"children\":[]},{\"level\":2,\"title\":\"Pagination\",\"slug\":\"pagination\",\"link\":\"#pagination\",\"children\":[]},{\"level\":2,\"title\":\"Limitation\",\"slug\":\"limitation\",\"link\":\"#limitation\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.47,\"words\":441},\"filePathRelative\":\"guide/blog/intro.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme supports blog feature with@vuepress/plugin-blog by default, and it's disabled by default.
\\n
If you need blog functionality, you can set plugins.blog: true in theme options to enable blog functionality.
After enabling the blog function, the theme allows you to configure categories, tags, whether it is an article, whether it appears in the timeline, stars, sticky and other functions through the frontmatter of the page.
-
-
Demo
-
Here is a demo for you to preview blog sites built with vuepress-theme-hope.
The theme provides a blog info sidebar. The sidebar will be displayed on the blog-related page (it will be displayed on the right side on the desktop, and retracted into the sidebar in mobile view)
-
You can control the display behavior of the sidebar on non-blog related pages through blog.sidebarDisplay in theme options. Optional values are "mobile" | "none" | "always". The default is "mobile", that is, when you visit non-blog related pages in mobile view, you can also see it in the sidebar.
For the list of articles on all pages, we will display a pagination component at the bottom. You can use this component to quickly jump to the first page, the last page, and the two pages before and after. You can also enter a number to jump to the specified page.
-
The default number of articles per page is 10, you can set blog.articlePerPage in theme options to override it.
For performance reasons, hot updates are not enabled for blog-related data by default in devServer, i.e. if you add new articles or modify the categories, time, tags, sticky, star, etc. of existing articles, the related data of the entire site will not update until you restart devServer.
-
In addition, since the blog information will be written to the underlying data of VuePress, modifying this file will cause application restart, so reading time (including word count information) which are sensitive to Markdown content will not take effect in devServer.
-
If you want these to take effect or be updated in real time, you need to set hotReload: true and accept the fact that each modification will trigger a page refresh and some time having white screen due to heavy recomputing work.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.js
deleted file mode 100644
index b51d74e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/path.html\",\"title\":\"Blog Page Path\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Blog Page Path\",\"icon\":\"link\",\"order\":7,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Path\"],\"description\":\"You can control the path of each page in the blog through plugins.blog in theme options. The default paths provided by the blog are as follows, if they conflict with your existi...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/path.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/path.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/path.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Blog Page Path\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can control the path of each page in the blog through plugins.blog in theme options. The default paths provided by the blog are as follows, if they conflict with your existi...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Path\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Blog Page Path\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.35,\"words\":104},\"filePathRelative\":\"guide/blog/path.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.vue
deleted file mode 100644
index 9170fb8..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/path.html.vue
+++ /dev/null
@@ -1,51 +0,0 @@
-
You can control the path of each page in the blog through plugins.blog in theme options.
-
The default paths provided by the blog are as follows, if they conflict with your existing paths, and you don't want to adjust your own paths, you can modify them.
-
-
-
-
Options
-
Description
-
Default Path
-
-
-
-
-
article
-
list of articles
-
/article/
-
-
-
category
-
Category map page
-
/category/
-
-
-
categoryItem
-
A list of specific categories
-
/category/:name/
-
-
-
tag
-
Tag map page
-
/tag/
-
-
-
tagItem
-
list of specific tags
-
/tag/:name/
-
-
-
star
-
List of starred articles
-
/star/
-
-
-
timeline
-
Timeline list
-
/timeline/
-
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.js
deleted file mode 100644
index efec759..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/blog/timeline.html\",\"title\":\"Timeline\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Timeline\",\"icon\":\"clock\",\"order\":5,\"category\":[\"Blog\"],\"tag\":[\"Blog\",\"Timeline\"],\"description\":\"You can access the time page through /timeline/. On the page, you can view all the articles in time reverse order. Timeline PageTimeline Page Excluding Articles By default, all ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/blog/timeline.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/blog/timeline.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/blog/timeline.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Timeline\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You can access the time page through /timeline/. On the page, you can view all the articles in time reverse order. Timeline PageTimeline Page Excluding Articles By default, all ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Blog\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Timeline\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Timeline\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Excluding Articles\",\"slug\":\"excluding-articles\",\"link\":\"#excluding-articles\",\"children\":[]},{\"level\":2,\"title\":\"Set Timeline title\",\"slug\":\"set-timeline-title\",\"link\":\"#set-timeline-title\",\"children\":[]},{\"level\":2,\"title\":\"Sidebar\",\"slug\":\"sidebar\",\"link\":\"#sidebar\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.41,\"words\":122},\"filePathRelative\":\"guide/blog/timeline.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.vue
deleted file mode 100644
index 68abc8b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/blog/timeline.html.vue
+++ /dev/null
@@ -1,12 +0,0 @@
-
You can access the time page through /timeline/. On the page, you can view all the articles in time reverse order.
By default, all articles which has a writing date will be displayed in timeline. If you don't want an article to be included, just set the timeline to false in the frontmatter of the article.
We have added a timeline tab in the sidebar of blog-related pages for users to quickly preview the timeline.
-Timeline Tab
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/component/built-in.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/component/built-in.html.js
deleted file mode 100644
index 7f519ef..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/component/built-in.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/component/built-in.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/component/built-in.html\",\"title\":\"Built-in Components\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Built-in Components\",\"icon\":\"puzzle-piece\",\"order\":4,\"category\":[\"Component\"],\"tag\":[\"Component\",\"Markdown\"],\"description\":\"By using vuepress-plugin-components, you can import and use some components in your Markdown files. Available components: ArtPlayer Badge BiliBili CodePen FontIcon PDF Share Sta...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/component/built-in.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/component/built-in.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/component/built-in.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Built-in Components\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"By using vuepress-plugin-components, you can import and use some components in your Markdown files. Available components: ArtPlayer Badge BiliBili CodePen FontIcon PDF Share Sta...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Component\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Built-in Components\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Utilities\",\"slug\":\"utilities\",\"link\":\"#utilities\",\"children\":[{\"level\":3,\"title\":\"Badge\",\"slug\":\"badge\",\"link\":\"#badge\",\"children\":[]},{\"level\":3,\"title\":\"SiteInfo\",\"slug\":\"siteinfo\",\"link\":\"#siteinfo\",\"children\":[]},{\"level\":3,\"title\":\"FontIcon\",\"slug\":\"fonticon\",\"link\":\"#fonticon\",\"children\":[]},{\"level\":3,\"title\":\"Share\",\"slug\":\"share\",\"link\":\"#share\",\"children\":[]}]},{\"level\":2,\"title\":\"Medias\",\"slug\":\"medias\",\"link\":\"#medias\",\"children\":[{\"level\":3,\"title\":\"VidStack\",\"slug\":\"vidstack\",\"link\":\"#vidstack\",\"children\":[]},{\"level\":3,\"title\":\"PDF\",\"slug\":\"pdf\",\"link\":\"#pdf\",\"children\":[]},{\"level\":3,\"title\":\"BiliBili\",\"slug\":\"bilibili\",\"link\":\"#bilibili\",\"children\":[]},{\"level\":3,\"title\":\"ArtPlayer\",\"slug\":\"artplayer\",\"link\":\"#artplayer\",\"children\":[]}]},{\"level\":2,\"title\":\"Code\",\"slug\":\"code\",\"link\":\"#code\",\"children\":[{\"level\":3,\"title\":\"CodePen\",\"slug\":\"codepen\",\"link\":\"#codepen\",\"children\":[]},{\"level\":3,\"title\":\"StackBlitz\",\"slug\":\"stackblitz\",\"link\":\"#stackblitz\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.28,\"words\":385},\"filePathRelative\":\"guide/component/built-in.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
By using vuepress-plugin-components, you can import and use some components in your Markdown files.
\\n
Available components:
\\n
\\n
ArtPlayer
\\n
Badge
\\n
BiliBili
\\n
CodePen
\\n
FontIcon
\\n
PDF
\\n
Share
\\n
StackBlitz
\\n
SiteInfo
\\n
VPBanner
\\n
VPCard
\\n
VidStack
\\n
XiGua
\\n
\\n
To enable components, you should set plugins.components.components with an array of components names.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/component/global.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/component/global.html.js
deleted file mode 100644
index 493311d..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/component/global.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/component/global.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/component/global.html\",\"title\":\"Global Components\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Global Components\",\"icon\":\"puzzle-piece\",\"order\":2,\"category\":[\"Component\"],\"tag\":[\"Component\"],\"description\":\"This tutorial will guide you on how to register components globally in your VuePress project.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/component/global.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/component/global.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/component/global.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Global Components\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial will guide you on how to register components globally in your VuePress project.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Component\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Global Components\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Register Components Globally\",\"slug\":\"register-components-globally\",\"link\":\"#register-components-globally\",\"children\":[]},{\"level\":2,\"title\":\"Register via @vuepress/plugin-register-components\",\"slug\":\"register-via-vuepress-plugin-register-components\",\"link\":\"#register-via-vuepress-plugin-register-components\",\"children\":[]},{\"level\":2,\"title\":\"Register via Client Config File\",\"slug\":\"register-via-client-config-file\",\"link\":\"#register-via-client-config-file\",\"children\":[]},{\"level\":2,\"title\":\"Usage\",\"slug\":\"usage\",\"link\":\"#usage\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.74,\"words\":221},\"filePathRelative\":\"guide/component/global.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial will guide you on how to register components globally in your VuePress project.
You can register components globally, so that you can use theme directly in Markdown files and Layouts.
-
-
Important
-
Registering components globally can make the component "out of box", so if a component is commonly used in your project, it is recommended to register it globally.
-
But if a component is large and only used in certain pages or layouts, it is recommended to register the component locally.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.js
deleted file mode 100644
index 027c966..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/component/\",\"title\":\"Component\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Component\",\"icon\":\"puzzle-piece\",\"dir\":{\"order\":3},\"index\":false,\"category\":[\"Component\"],\"tag\":[\"Component\"],\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/component/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/component/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/component/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Component\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Component\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Component\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.05,\"words\":16},\"filePathRelative\":\"guide/component/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\"}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.vue
deleted file mode 100644
index c6d50c0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/component/index.html.vue
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/component/sfc.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/component/sfc.html.js
deleted file mode 100644
index 0022225..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/component/sfc.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/component/sfc.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/component/sfc.html\",\"title\":\"Markdown to Vue SFC\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Markdown to Vue SFC\",\"icon\":\"fab fa-vuejs\",\"order\":1,\"category\":[\"Component\"],\"tag\":[\"Component\",\"SFC\"],\"description\":\"This tutorial will explain how to every Markdown files are converted to a Vue-powered page.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/component/sfc.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/component/sfc.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/component/sfc.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Markdown to Vue SFC\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial will explain how to every Markdown files are converted to a Vue-powered page.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Component\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"SFC\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Markdown to Vue SFC\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Markdown to Vue SFC\",\"slug\":\"markdown-to-vue-sfc\",\"link\":\"#markdown-to-vue-sfc\",\"children\":[]},{\"level\":2,\"title\":\"Using Vue syntax in Markdown\",\"slug\":\"using-vue-syntax-in-markdown\",\"link\":\"#using-vue-syntax-in-markdown\",\"children\":[]},{\"level\":2,\"title\":\"Importing files\",\"slug\":\"importing-files\",\"link\":\"#importing-files\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.23,\"words\":370},\"filePathRelative\":\"guide/component/sfc.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial will explain how to every Markdown files are converted to a Vue-powered page.
Every Markdown file is first compiled to HTML and then converted to a Vue Single File Component (SFC). In other words, you can write Markdown files like Vue SFC.
-
-
<script> and <style> tags are directly treated as tags in Vue SFC. In other words, they are promoted from the <template> tag to the top level of the SFC.
-
All content other than <script> and <style> tags will be compiled to HTML and then treated as <template> tags in Vue SFC.
-
-
The converted Vue SFC will be cached in the .vuepress/.temp/pages directory, and will be rendered by the internal <Content /> component.
Since Markdown will be converted to Vue single-file components in the cache directory, relative imports will not work in markdown files since they are invalid in Vue SFC. You should use alias.
-
-
-
-
You can use @source alias to reference the source directory of the current project
Global component needs to be loaded when VuePress is initialized (i.e., when visiting the first page). So if a global component is heavy, it will affect the initial loading time of the site.
-
Importing in Markdown locally means components will only be loaded when visiting the page that uses it.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/color.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/customize/color.html.js
deleted file mode 100644
index a7a061e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/color.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/customize/color.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/customize/color.html\",\"title\":\"Customize color\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Customize color\",\"icon\":\"palette\",\"order\":1,\"category\":[\"Cookbook\",\"Customize\"],\"tag\":[\"Customize\"],\"description\":\"This page guides you how to customize theme colors.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/customize/color.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/customize/color.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/customize/color.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Customize color\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This page guides you how to customize theme colors.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Customize color\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Modify the built-in color\",\"slug\":\"modify-the-built-in-color\",\"link\":\"#modify-the-built-in-color\",\"children\":[]},{\"level\":2,\"title\":\"Modify other colors\",\"slug\":\"modify-other-colors\",\"link\":\"#modify-other-colors\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.88,\"words\":265},\"filePathRelative\":\"guide/customize/color.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This page guides you how to customize theme colors.
Sometimes, you may want to modify some colors that are not in palette.scss, such as the background color of the code block. At this time, you can check whether the corresponding color attribute value is a CSS variable through the devTools. If so, you can go to index.scss to manually override this variable value:
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/external.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/customize/external.html.js
deleted file mode 100644
index c73ae38..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/external.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/customize/external.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/customize/external.html\",\"title\":\"External Scripts and Styles\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"External Scripts and Styles\",\"icon\":\"wand-magic-sparkles\",\"order\":7,\"category\":[\"Cookbook\",\"Customize\"],\"tag\":[\"Customize\"],\"description\":\"This tutorial guides you how to add external scripts and styles to your site.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/customize/external.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/customize/external.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/customize/external.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"External Scripts and Styles\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This tutorial guides you how to add external scripts and styles to your site.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"External Scripts and Styles\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Global\",\"slug\":\"global\",\"link\":\"#global\",\"children\":[]},{\"level\":2,\"title\":\"Per Page\",\"slug\":\"per-page\",\"link\":\"#per-page\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.54,\"words\":161},\"filePathRelative\":\"guide/customize/external.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
This tutorial guides you how to add external scripts and styles to your site.
Because different platforms, different operating systems, and different installation methods (slim/full) will cause huge differences in the number and types of fonts in the font library, you should set as many fonts as possible, and ensure that the fallback fonts [3] exists.
-
-
Best Practices
-
The fallback font [3:1] can ensure that your website displays well on different operating systems and devices with different fonts installed.
You can find more fonts in Google Fonts, and you can preview and download them online.
-
Please search and select the font and weight you want in the webpage, then click the Select button on the right to add it to your selection list, then click the button in the upper right corner to view your favorite fonts and get the link Imported in the configuration file of VuePress.
-
We assume that you have selected the 400 and 700 italic fonts of Lora font. After clicking the button in the upper right corner, Google will give the following code in the sidebar:
No one shall be subjected to arbitrary arrest, detention or exile.
-Everyone is entitled in full equality to a fair and public hearing by an independent and impartial tribunal, in the determination of his rights and obligations and of any criminal charge against him.
-No one shall be subjected to arbitrary interference with his privacy, family, home or correspondence, nor to attacks upon his honour and reputation. Everyone has the right to the protection of the law against such interference or attacks.
Fallback fonts are fonts that are used to display missing characters when the displayed font lacks certain characters. Because it serves as the last line of defense for display, fallback fonts should contain all Unicode characters where possible.
-
When a missing character has no fallback font for display, the missing character is usually displayed as a black square, white hollow square, question mark, Unicode placeholder (U+FFFD), or simply skipped. In practice, systems such as CSS that support sequential display of font lists usually put one or more sets of fallback fonts at the end of the list to prevent missing characters. ↩︎↩︎
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.js
deleted file mode 100644
index fea5e6c..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/customize/\",\"title\":\"Customize\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Customize\",\"icon\":\"gear\",\"dir\":{\"order\":8},\"category\":[\"Customize\"],\"tag\":[\"Customize\"],\"description\":\"This section shows you the relevant codes involved in common customization. How to Customize Styles You can create three files under .vuepress/styles folder in your own document...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/customize/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/customize/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/customize/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This section shows you the relevant codes involved in common customization. How to Customize Styles You can create three files under .vuepress/styles folder in your own document...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Customize\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"How to Customize Styles\",\"slug\":\"how-to-customize-styles\",\"link\":\"#how-to-customize-styles\",\"children\":[]},{\"level\":2,\"title\":\"Basic Tutorials\",\"slug\":\"basic-tutorials\",\"link\":\"#basic-tutorials\",\"children\":[]},{\"level\":2,\"title\":\"Advanced Usage\",\"slug\":\"advanced-usage\",\"link\":\"#advanced-usage\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.53,\"words\":159},\"filePathRelative\":\"guide/customize/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.vue
deleted file mode 100644
index 08d98e4..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/index.html.vue
+++ /dev/null
@@ -1,52 +0,0 @@
-
This section shows you the relevant codes involved in common customization.
The theme provides many layout-related options for you to customize the layout of the theme. For details about these options, see Theme Configuration → Layout.
The theme will automatically apply responsive layouts under different screen widths. If you need to modify these breakpoints, you can modify them in style config file.
-
// Modify the breakpoint of the desktop layout
-$pc = 1280px;
-
For details about breakpoint variables $pc, $laptop, $pad, $tablet, $mobile, see Theme Configuration → Styles.
The theme provides common size variables in the style palette file, and you can modify these variables in the palette file to achieve the purpose of modifying the layout size.
-
// Modify the height of the navigation bar
-$navbar-height = 80px;
-
Introduction of layout variables can be found at Theme Configuration → Style.
You can add new layouts or override existing layouts via layouts option in client config file.
-
-
-TS
-JS
-
-
import { defineClientConfig } from "vuepress/client";
-import Changelog from "./layouts/Changelog.vue";
-import Layout from "./layouts/Layout.vue";
-
-export default defineClientConfig({
- // You can override or add layouts here
- layouts: {
- // For example, here we change the default layout of vuepress-theme-hope to layouts/Layout.vue
- Layout,
- // Also we added a Changelog layout
- Changelog,
- },
-});
-
-
-
import { defineClientConfig } from "vuepress/client";
-import Changelog from "./layouts/Changelog.vue";
-import Layout from "./layouts/Layout.vue";
-
-export default defineClientConfig({
- // You can override or add layouts here
- layouts: {
- // For example, here we change the default layout of vuepress-theme-hope to layouts/Layout.vue
- Layout,
- // Also we added a Changelog layout
- Changelog,
- },
-});
-
-
-
-
The theme provides the following layouts:
-
-
-
Layout
-
Basic layout, having the following slots:
-
-
default: Page content slot
-
top: Page top slot
-
bottom: Page bottom slot
-
contentBefore: Slot before page content
-
contentAfter: Slot after page content
-
tocBefore: Slot before page TOC
-
tocAfter: Slot after page TOC
-
-
-
-
NotFound
-
404 page layout, having the following slots:
-
-
default: 404 content slot
-
-
-
-
Slide (Only available when reveal.js is enabled)
-
-
-
BlogCategory (Only available when blog is enabled)
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.js
deleted file mode 100644
index 0fb30d9..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/customize/presets.html\",\"title\":\"Theme Presets\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Presets\",\"icon\":\"palette\",\"order\":6,\"category\":[\"Customize\"],\"tag\":[\"Customize\",\"Preset\"],\"description\":\"In order to meet the needs of different users, the theme provides some presets, you can get them under vuepress-theme-hope/presets and import them yourself. Component related Ti...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/customize/presets.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/customize/presets.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/customize/presets.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Presets\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"In order to meet the needs of different users, the theme provides some presets, you can get them under vuepress-theme-hope/presets and import them yourself. Component related Ti...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Customize\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Preset\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Presets\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Component related\",\"slug\":\"component-related\",\"link\":\"#component-related\",\"children\":[{\"level\":3,\"title\":\"Bing Wallpapers\",\"slug\":\"bing-wallpapers\",\"link\":\"#bing-wallpapers\",\"children\":[]},{\"level\":3,\"title\":\"Hitokoto Description\",\"slug\":\"hitokoto-description\",\"link\":\"#hitokoto-description\",\"children\":[]}]},{\"level\":2,\"title\":\"Composable Related\",\"slug\":\"composable-related\",\"link\":\"#composable-related\",\"children\":[{\"level\":3,\"title\":\"Transparent Navbar\",\"slug\":\"transparent-navbar\",\"link\":\"#transparent-navbar\",\"children\":[]},{\"level\":3,\"title\":\"Running time\",\"slug\":\"running-time\",\"link\":\"#running-time\",\"children\":[]}]},{\"level\":2,\"title\":\"Style Related\",\"slug\":\"style-related\",\"link\":\"#style-related\",\"children\":[{\"level\":3,\"title\":\"Docs\",\"slug\":\"docs\",\"link\":\"#docs\",\"children\":[]},{\"level\":3,\"title\":\"Blog\",\"slug\":\"blog\",\"link\":\"#blog\",\"children\":[]},{\"level\":3,\"title\":\"Others\",\"slug\":\"others\",\"link\":\"#others\",\"children\":[]}]},{\"level\":2,\"title\":\"More\",\"slug\":\"more\",\"link\":\"#more\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.04,\"words\":613},\"filePathRelative\":\"guide/customize/presets.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.vue
deleted file mode 100644
index da33ea6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/customize/presets.html.vue
+++ /dev/null
@@ -1,188 +0,0 @@
-
In order to meet the needs of different users, the theme provides some presets, you can get them under vuepress-theme-hope/presets and import them yourself.
Replace the description of the blog's home page with a random Hitokoto sentence (Chinese only).
-
Components:
-
-
"vuepress-theme-hope/presets/HitokotoBlogHero.js": A sentence component
-
-
Usage:
-
Override @theme-hope/modules/blog/components/BlogHero, import the above component into the info slot of the original BlogHero, and pass in the slot properties as they are.
This feature is enabled by default. If there is no README.md in the folder, the theme will automatically generate a directory page for it. To disable, set plugins.catalog to false.
-
You can control this via plugins.catalog in the theme options, for example:
-
-
Exclude some folders from catalog generation via plugins.catalog.exclude
-
Control frontmatter generation through plugins.catalog.frontmatter.
You need to create a public repository and open discussion as a place to store comments
-
You need to install the Giscus App to have permission to access the corresponding repository.
-
-
After completing the above steps, please go to the Giscus page to get your settings. You just need to fill in the repository and Discussion categories, then scroll to the "Enable giscus" section at the bottom of the page and copy the data-repo, data-repo-id, data-category and data-category-id four items as they are required.
Sign in or sign up leancloud. Then create new application in Leancloud, and you will get APP ID / APP Key / APP Master Key.
-
After that, create a vercel app using the below button.
-Vercel
-
Then input your new GitHub repo name and set LEAN_ID, LEAN_KEY and LEAN_MASTER_KEY environment variables in the "Environment Variables" column. APP ID is the value of LEAN_ID, and APP Key to LEAN_KEY, Master Key to LEAN_MASTER_KEY.
-
Click Deploy button to deploy. It will show you deploy successfully after some time. Then config the vercel link in your theme options:
Create a free MongoDB database, the recommended region is AWS / N. Virginia (us-east-1)
-
-
-
Click CONNECT on the Clusters page, follow the steps to allow connections from all IP addresses (Why?), create Database user, and record the database connection string, please change the <password> in the connection string to the database password
Click the button below to deploy Twikoo to Vercel in one click
-Vercel
-
-
-
Go to Settings - Environment Variables, add the environment variable MONGODB_URI, the value is the database connection string in step 3
-
-
-
Go to Overview, click the link under Domains, if the environment configuration is correct, you can see the prompt "Twikoo cloud function is running normally"
-
-
-
Vercel Domains (with https:// prefix, for example https://xxx.vercel.app) is your environment ID
The plugin retains the el option and inserts Artalk itself on the page. At the same time, the plugin will automatically set the pageTitle, pageKey and site options for you according to the VuePress information.
-
Before VuePress2 provides client configuration, the two function options imgUploader and avatarURLBuilder are not supported.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/copy-code.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/copy-code.html.js
deleted file mode 100644
index 212ba40..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/copy-code.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/copy-code.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/copy-code.html\",\"title\":\"Code Copy\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Code Copy\",\"icon\":\"copy\",\"category\":[\"Feature\"],\"tag\":[\"Copy Code\",\"Feature\"],\"description\":\"If you are a programmer, you may want your users to be able to copy the code you show in the text with one click. For this, vuepress-theme-hope use [@vuepress/plugin-copy-code][...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/copy-code.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/copy-code.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/copy-code.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Code Copy\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"If you are a programmer, you may want your users to be able to copy the code you show in the text with one click. For this, vuepress-theme-hope use [@vuepress/plugin-copy-code][...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Copy Code\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Code Copy\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Usage\",\"slug\":\"usage\",\"link\":\"#usage\",\"children\":[]},{\"level\":2,\"title\":\"Effect\",\"slug\":\"effect\",\"link\":\"#effect\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.59,\"words\":178},\"filePathRelative\":\"guide/feature/copy-code.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
If you are a programmer, you may want your users to be able to copy the code you show in the text with one click.
\\n
For this, vuepress-theme-hope use [@vuepress/plugin-copy-code][copy-code] to provide a copy button on code blocks.
\\n
\\n
Info
\\n
vuepress-theme-hope passes plugins.copyCode in theme options as plugin options to @vuepress/plugin-copy-code.
After enabling, this plugin will automatically add a copy button to the top right corner of each code block.
-
By default, the button is only displayed on desktop mode. To display this button on mobile devices, set plugins.copyCode.showInMobile to true in theme options.
-
After user press the copy button, a success hint will display on the screen. The default hint duration is 2000 ms, to change the duration, please set plugins.copyCode.duration in theme options. To disable the hint, set duration to 0.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/copyright.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/copyright.html.js
deleted file mode 100644
index e28b8c9..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/copyright.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/copyright.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/copyright.html\",\"title\":\"Copyright\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Copyright\",\"icon\":\"copyright\",\"category\":[\"Feature\"],\"tag\":[\"Copyright\",\"Feature\"],\"copy\":{\"minLength\":40},\"description\":\"You may not want some of your articles to be copied by others, or you want copyright information appended to the clipboard when copying. vuepress-theme-hope use [@vuepress/plugi...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/copyright.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/copyright.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/copyright.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Copyright\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"You may not want some of your articles to be copied by others, or you want copyright information appended to the clipboard when copying. vuepress-theme-hope use [@vuepress/plugi...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Copyright\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Copyright\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Enable plugin\",\"slug\":\"enable-plugin\",\"link\":\"#enable-plugin\",\"children\":[]},{\"level\":2,\"title\":\"Disable Copy and Selection\",\"slug\":\"disable-copy-and-selection\",\"link\":\"#disable-copy-and-selection\",\"children\":[]},{\"level\":2,\"title\":\"Copyright Information\",\"slug\":\"copyright-information\",\"link\":\"#copyright-information\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]},{\"level\":2,\"title\":\"More\",\"slug\":\"more\",\"link\":\"#more\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.63,\"words\":488},\"filePathRelative\":\"guide/feature/copyright.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
You may not want some of your articles to be copied by others, or you want copyright information appended to the clipboard when copying. \\nvuepress-theme-hope use [@vuepress/plugin-copyright][copyright] to provide this feature.
\\n
\\n
Info
\\n
vuepress-theme-hope passes plugins.copyright in theme options to @vuepress/plugin-copyright.
You may not want some of your articles to be copied by others, or you want copyright information appended to the clipboard when copying.
-vuepress-theme-hope use @vuepress/plugin-copyright to provide this feature.
-
-
Info
-
vuepress-theme-hope passes plugins.copyright in theme options to @vuepress/plugin-copyright.
Since half of the users use this theme to build documents, and document sites usually do not need to add copyright information, this plugin is not enabled by default.
-
-
Info
-
To enable this plugin, you need to set plugins.copyright in theme options to true or an object.
-
Setting to true is equivalent to setting { global: true }.
-
-
-
When the global option of the plugin is not true, the plugin is disabled globally, and you need to manually enable it by setting copy: true in page frontmatter.
-
Setting global: true makes it enabled globally, and allows setting copy: false in page frontmatter to disable it.
-
-
To avoid disturbing visitors, copyright information will be appended only when the length of content copied by the user is not less than 100. If you want to change this trigger value, please set triggerLength, and this option supports being overridden via copy.triggerLength in page frontmatter.
If you don't want users to copy your entire site or specific page text, you can disable copying in plugin options or page frontmatter by setting disableCopy, the latter has higher priority.
-
If you don't want users to select your entire site or specific page text, you can disable selection in plugin options or page frontmatter by setting disableSelection, the latter has higher priority.
You can set author and license information via author and license in plugin options. If your site have different authors and license in different pages, you can pass in a function (page: Page) => string that takes the current page object as parameter and returns the corresponding information.
Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect. Please copy this text and paste it to any location to see the effect.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/encrypt.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/encrypt.html.js
deleted file mode 100644
index fb43d52..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/encrypt.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/encrypt.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/encrypt.html\",\"title\":\"Encryption\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Encryption\",\"icon\":\"lock\",\"category\":[\"Feature\"],\"tag\":[\"Encrypt\",\"Feature\"],\"description\":\"The theme supports encryption of specific folders or specific paths, as well as global scope encryption. Caution Note that because of the limitation of vuepress, the content of ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/encrypt.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/encrypt.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/encrypt.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Encryption\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme supports encryption of specific folders or specific paths, as well as global scope encryption. Caution Note that because of the limitation of vuepress, the content of ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Encrypt\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Encryption\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Local Encryption\",\"slug\":\"local-encryption\",\"link\":\"#local-encryption\",\"children\":[]},{\"level\":2,\"title\":\"Global encryption\",\"slug\":\"global-encryption\",\"link\":\"#global-encryption\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.86,\"words\":259},\"filePathRelative\":\"guide/feature/encrypt.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme supports encryption of specific folders or specific paths, as well as global scope encryption.
\\n
\\n
Caution
\\n
Note that because of the limitation of vuepress, the content of the article is only hidden before being decrypted, and visitors can still get the content of the article from the source code (from js).
\\n
Please DO NOT USE this encryption function for any sensitive and confidential articles and files, please bear the consequences of it.
The theme supports encryption of specific folders or specific paths, as well as global scope encryption.
-
-
Caution
-
Note that because of the limitation of vuepress, the content of the article is only hidden before being decrypted, and visitors can still get the content of the article from the source code (from js).
-
Please DO NOT USE this encryption function for any sensitive and confidential articles and files, please bear the consequences of it.
You can configure encryption options through the encrypt.config options in theme options.
-
import { hopeTheme } from "vuepress-theme-hope";
-
-export default {
- theme: hopeTheme({
- encrypt: {
- config: {
- // This will encrypt the entire guide directory, and both passwords are available
- "/guide/": ["1234", "5678"],
- // This will only encrypt /config/page.html
- "/config/page.html": "1234",
- },
- },
- }),
-};
-
-
Warning
-
Note that you can only use passwords in string format.
-
The salted hash value of the number 1234 and the string "1234" is different! While user can only enter the content in the string format through the input box.
In some cases, you may want to encrypt the entire site, you can set encrypt.global: true in theme options to do that.
-
For global encryption, you can set one or more passwords in the format of string or string array in encrypt.admin.
-
-
Tips
-
The consideration of multiple passwords is separation of permissions. This allows you to deprecate or update some of the global passwords in future deployments, so that some users with certain password will lose access.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.js
deleted file mode 100644
index df849d1..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/\",\"title\":\"Features\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Features\",\"icon\":\"splotch\",\"index\":false,\"dir\":{\"order\":6},\"description\":\"vuepress-theme-hope introduces lots of great features. Most of the functions are separated into plugins, which means if you like them, you can use them in other VuePress themes ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Features\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope introduces lots of great features. Most of the functions are separated into plugins, which means if you like them, you can use them in other VuePress themes ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Features\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.22,\"words\":66},\"filePathRelative\":\"guide/feature/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.vue
deleted file mode 100644
index 9d5302d..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/index.html.vue
+++ /dev/null
@@ -1,8 +0,0 @@
-
vuepress-theme-hope introduces lots of great features. Most of the functions are separated into plugins, which means if you like them, you can use them in other VuePress themes or @vuepress/theme-default.
-
-
Info
-
All the plugin settings are under plugins field in theme options, and the option name is related with their names.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/meta.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/meta.html.js
deleted file mode 100644
index 10e0957..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/meta.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/meta.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/meta.html\",\"title\":\"Page Meta\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Page Meta\",\"icon\":\"clock\",\"category\":[\"Feature\"],\"tag\":[\"Feature\",\"Meta\"],\"description\":\"The theme displays last update time and contributors of the page via the [@vuepress/plugin-git][git] plugin, and provides support for an \\\"edit this page\\\" button. The theme also ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/meta.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/meta.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/meta.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Page Meta\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme displays last update time and contributors of the page via the [@vuepress/plugin-git][git] plugin, and provides support for an \\\"edit this page\\\" button. The theme also ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Meta\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Page Meta\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Git-based Information\",\"slug\":\"git-based-information\",\"link\":\"#git-based-information\",\"children\":[]},{\"level\":2,\"title\":\"Edit Link\",\"slug\":\"edit-link\",\"link\":\"#edit-link\",\"children\":[]},{\"level\":2,\"title\":\"Display Control\",\"slug\":\"display-control\",\"link\":\"#display-control\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.22,\"words\":365},\"filePathRelative\":\"guide/feature/meta.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme displays last update time and contributors of the page via the [@vuepress/plugin-git][git] plugin, and provides support for an \\\"edit this page\\\" button.
\\n
The theme also provides navigation buttons for previous and next pages depending on sidebar config.
The theme displays last update time and contributors of the page via the @vuepress/plugin-git plugin, and provides support for an "edit this page" button.
-
The theme also provides navigation buttons for previous and next pages depending on sidebar config.
vuepress-theme-hope uses the built-in @vuepress/plugin-git plugin to automatically generate page create time, last update time and contributors.
-
The plugin will automatically generate the page creation time and last update time from the UNIX timestamp (ms) of git commit history of the page file, and generate contributors based on the commit record.
-
The theme will display last update time in the appropriate date format, along with all page contributors at the bottom of the page.
-
-
Tips
-
The theme will use Date.toLocaleString(pageLang) to automatically localize the text of last update time according to the current language.
-
-
-
Limitations
-
-
-
Since the contributors, last update time, and file creation time information are based on git, you can only enable it in a git based project.
-
-
-
Since related information are from git commits, they will only be displayed after the first commit for a given page, and will only be updated when some commits change that page.
-
-
-
Since the git plugin needs to call Git binary and involves file IO, this function will seriously affect the startup and hot update speed, so by default theme will not be enabled in devServer. Set plugins.git: true or hotReload: true in theme options if needed.
To hide these items globally, set the corresponding items below to false in theme options. You can also enable/disable specific pages by setting these items in YAML front matter:
-
-
lastUpdated: whether to display last update time of the page
-
contributors: whether to show page contributors
-
editLink: whether to display "edit page" link
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/page-info.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/page-info.html.js
deleted file mode 100644
index 7adbdc6..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/page-info.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/page-info.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/page-info.html\",\"title\":\"Page information\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Page information\",\"icon\":\"circle-info\",\"category\":[\"Feature\"],\"tag\":[\"Feature\",\"Page Info\"],\"description\":\"vuepress-theme-hope can display article information for you.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/page-info.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/page-info.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/page-info.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Page information\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope can display article information for you.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Page Info\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Page information\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Enable\",\"slug\":\"enable\",\"link\":\"#enable\",\"children\":[]},{\"level\":2,\"title\":\"Parameters\",\"slug\":\"parameters\",\"link\":\"#parameters\",\"children\":[{\"level\":3,\"title\":\"author\",\"slug\":\"author\",\"link\":\"#author\",\"children\":[]},{\"level\":3,\"title\":\"Writing Date\",\"slug\":\"writing-date\",\"link\":\"#writing-date\",\"children\":[]},{\"level\":3,\"title\":\"Category and Tags\",\"slug\":\"category-and-tags\",\"link\":\"#category-and-tags\",\"children\":[]},{\"level\":3,\"title\":\"Reading Time\",\"slug\":\"reading-time\",\"link\":\"#reading-time\",\"children\":[]},{\"level\":3,\"title\":\"View Count\",\"slug\":\"view-count\",\"link\":\"#view-count\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.38,\"words\":413},\"filePathRelative\":\"guide/feature/page-info.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope can display article information for you.
Page information display is enabled globally by default, while supports page config. You can disable it by setting pageInfo: false in frontmatter of a specific page.
-
To keep it globally disabled, please set pageInfo to false in the plugin options. Then you can set pageInfo in frontmatter of a specific page to enable it locally.
You can configure author in the plugin options to set the default author. And you can also configure author in frontmatter with a new value in the page to override the default author, or set it to false to cancel the author display.
-
Authors support string[], string, AuthorInfo and AuthorInfo[].
We recommend filling it with a standard date format. A standard format is in the form of xxxx-xx-xx, such as "April 1, 2020" should be written as 2020-04-01.
-
Example:
-
---
-date: 2020-01-01
----
-
-
Note
-
When running in a Git-based project, the writing date will fall back to first commit date of current file.
The default statistic method is 300 words per minute. You can override it by setting plugins.readingTime.wordPerMinute in theme options. This option does not support individual configuration on the page.
When using Waline as Comment Service, this function is enabled by default.
-
Example:
-
---
-pageview: false
----
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/photo-swipe.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/photo-swipe.html.js
deleted file mode 100644
index 94ab7bc..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/photo-swipe.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/photo-swipe.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/photo-swipe.html\",\"title\":\"Image Preview\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Image Preview\",\"icon\":\"image\",\"category\":[\"Feature\"],\"tag\":[\"Feature\",\"Image Preview\"],\"description\":\"By using [@vuepress/plugin-photo-swipe][photo-swipe], clicking images in pages will enter preview mode. If you don't need this feature, you can set plugins.photoSwipe: false in ...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/photo-swipe.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/photo-swipe.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/photo-swipe.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Image Preview\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"By using [@vuepress/plugin-photo-swipe][photo-swipe], clicking images in pages will enter preview mode. If you don't need this feature, you can set plugins.photoSwipe: false in ...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Image Preview\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Image Preview\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Browse Mode\",\"slug\":\"browse-mode\",\"link\":\"#browse-mode\",\"children\":[]},{\"level\":2,\"title\":\"Customize Config\",\"slug\":\"customize-config\",\"link\":\"#customize-config\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.84,\"words\":253},\"filePathRelative\":\"guide/feature/photo-swipe.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
By using [@vuepress/plugin-photo-swipe][photo-swipe], clicking images in pages will enter preview mode.
\\n
If you don't need this feature, you can set plugins.photoSwipe: false in theme options to disable it.
Swipe left and right to preview other pictures on the page in order
-
View the description of the picture
-
Zoom in and zoom out the picture
-
View pictures in full screen
-
Download pictures
-
Share pictures
-
-
-
Tips
-
-
Besides clicking "×" in the upper right corner to exit the preview mode, scrolling up and down more than a certain distance will also exit preview mode
-
On mobile devices, or using the PC trackpad, you can use pan and zoom gestures to pan and zoom in the preview mode
-
-
-
-
\ No newline at end of file
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/feature/search.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/feature/search.html.js
deleted file mode 100644
index 012e39a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/feature/search.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/feature/search.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/feature/search.html\",\"title\":\"Search\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Search\",\"icon\":\"search\",\"category\":[\"Feature\"],\"tag\":[\"Feature\",\"Search\"],\"description\":\"The theme adds built-in support for , [@vuepress/plugin-docsearch][docsearch] and [@vuepress/plugin-search][search]. Just install the plugin you want and config it, you will get...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/feature/search.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/feature/search.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/feature/search.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Search\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme adds built-in support for , [@vuepress/plugin-docsearch][docsearch] and [@vuepress/plugin-search][search]. Just install the plugin you want and config it, you will get...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Feature\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Search\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Search\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Use @vuepress/plugin-docsearch\",\"slug\":\"use-vuepress-plugin-docsearch\",\"link\":\"#use-vuepress-plugin-docsearch\",\"children\":[]},{\"level\":2,\"title\":\"Use vuepress-plugin-search-pro\",\"slug\":\"use-vuepress-plugin-search-pro\",\"link\":\"#use-vuepress-plugin-search-pro\",\"children\":[]},{\"level\":2,\"title\":\"Use @vuepress/plugin-search\",\"slug\":\"use-vuepress-plugin-search\",\"link\":\"#use-vuepress-plugin-search\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.02,\"words\":906},\"filePathRelative\":\"guide/feature/search.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme adds built-in support for , [@vuepress/plugin-docsearch][docsearch] and [@vuepress/plugin-search][search]. Just install the plugin you want and config it, you will get a search box in navbar.
The theme adds built-in support for vuepress-plugin-search-pro, @vuepress/plugin-docsearch and @vuepress/plugin-search. Just install the plugin you want and config it, you will get a search box in navbar.
The DocSearch team will send apiKey and indexName to your email once the index is generated. Then you can configure this plugin to enable DocSearch in VuePress.
-
Alternatively, you can run your own crawler to generate the index, and then use your own appId, apiKey and indexName to configure this plugin.
-
-
-
Set up the Algolia Crawler correctly according to the following requirements. You should go to Algolia Crawler to update your crawler config.
-Setting Crawler Config
-
Here are config options and descriptions:
-
new Crawler({
- appId: "YOUR_APP_ID",
- apiKey: "YOUR_API_KEY",
- rateLimit: 8,
- startUrls: [
- // These are urls which algolia start to craw
- // If your site is divided in to multiple parts,
- // you may want to set multiple entry links
- "https://YOUR_WEBSITE_URL/",
- ],
- sitemaps: [
- // if you are using sitemap plugins (e.g.: @vuepress/plugin-sitemap), you may provide one
- "https://YOUR_WEBSITE_URL/sitemap.xml",
- ],
- ignoreCanonicalTo: false,
- exclusionPatterns: [
- // You can use this to stop algolia crawling some paths
- ],
- discoveryPatterns: [
- // These are urls which algolia looking for,
- "https://YOUR_WEBSITE_URL/**",
- ],
- // Crawler schedule, set it according to your docs update frequency
- schedule: "at 02:00 every 1 day",
- actions: [
- // you may have multiple actions, especially when you are deploying multiple docs under one domain
- {
- // name the index with name you like
- indexName: "YOUR_INDEX_NAME",
- // paths where the index take effect
- pathsToMatch: ["https://YOUR_WEBSITE_URL/**"],
- // controls how algolia extracts records from your site
- recordExtractor: ({ $, helpers }) => {
- // The following are the default options for vuepress-theme-hope
- // vuepress-theme-hope default container class name is theme-hope-content
- return helpers.docsearch({
- recordProps: {
- lvl0: {
- selectors: [
- ".vp-sidebar-page.active",
- ".theme-hope-content h1",
- ],
- defaultValue: "Documentation",
- },
- lvl1: ".theme-hope-content h1",
- lvl2: ".theme-hope-content h2",
- lvl3: ".theme-hope-content h3",
- lvl4: ".theme-hope-content h4",
- lvl5: ".theme-hope-content h5",
- lvl6: ".theme-hope-content h6",
- content: ".theme-hope-content p, .theme-hope-content li",
- },
- recordVersion: "v3",
- });
- },
- },
- ],
- initialIndexSettings: {
- // controls how index are initialized
- // only has effects before index are initialize
- // you may need to delete your index and recraw after modification
- YOUR_INDEX_NAME: {
- attributesForFaceting: ["type", "lang"],
- attributesToRetrieve: ["hierarchy", "content", "anchor", "url"],
- attributesToHighlight: ["hierarchy", "hierarchy_camel", "content"],
- attributesToSnippet: ["content:10"],
- camelCaseAttributes: ["hierarchy", "hierarchy_radio", "content"],
- searchableAttributes: [
- "unordered(hierarchy_radio_camel.lvl0)",
- "unordered(hierarchy_radio.lvl0)",
- "unordered(hierarchy_radio_camel.lvl1)",
- "unordered(hierarchy_radio.lvl1)",
- "unordered(hierarchy_radio_camel.lvl2)",
- "unordered(hierarchy_radio.lvl2)",
- "unordered(hierarchy_radio_camel.lvl3)",
- "unordered(hierarchy_radio.lvl3)",
- "unordered(hierarchy_radio_camel.lvl4)",
- "unordered(hierarchy_radio.lvl4)",
- "unordered(hierarchy_radio_camel.lvl5)",
- "unordered(hierarchy_radio.lvl5)",
- "unordered(hierarchy_radio_camel.lvl6)",
- "unordered(hierarchy_radio.lvl6)",
- "unordered(hierarchy_camel.lvl0)",
- "unordered(hierarchy.lvl0)",
- "unordered(hierarchy_camel.lvl1)",
- "unordered(hierarchy.lvl1)",
- "unordered(hierarchy_camel.lvl2)",
- "unordered(hierarchy.lvl2)",
- "unordered(hierarchy_camel.lvl3)",
- "unordered(hierarchy.lvl3)",
- "unordered(hierarchy_camel.lvl4)",
- "unordered(hierarchy.lvl4)",
- "unordered(hierarchy_camel.lvl5)",
- "unordered(hierarchy.lvl5)",
- "unordered(hierarchy_camel.lvl6)",
- "unordered(hierarchy.lvl6)",
- "content",
- ],
- distinct: true,
- attributeForDistinct: "url",
- customRanking: [
- "desc(weight.pageRank)",
- "desc(weight.level)",
- "asc(weight.position)",
- ],
- ranking: [
- "words",
- "filters",
- "typo",
- "attribute",
- "proximity",
- "exact",
- "custom",
- ],
- highlightPreTag:
- '<span class="algolia-docsearch-suggestion--highlight">',
- highlightPostTag: "</span>",
- minWordSizefor1Typo: 3,
- minWordSizefor2Typos: 7,
- allowTyposOnNumericTokens: false,
- minProximity: 1,
- ignorePlurals: true,
- advancedSyntax: true,
- attributeCriteriaComputedByMinProximity: true,
- removeWordsIfNoResults: "allOptional",
- },
- },
-});
-
-
-
Warning
-
initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting field must contain "lang", otherwise the plugin will not work properly.
-
-
-
-
Install @vuepress/plugin-docsearch
-
-pnpm
-yarn
-npm
-
-
pnpm add -D @vuepress/plugin-docsearch@next
-
-
-
yarn add -D @vuepress/plugin-docsearch@next
-
-
-
npm i -D @vuepress/plugin-docsearch@next
-
-
-
-
-
Customize the plugin with plugins.docsearch in theme options.
-
import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-export default defineUserConfig({
- theme: hopeTheme({
- plugins: {
- docsearch: {
- // plugin options here
- // appId, apiKey and indexName are required
- },
- },
- }),
-});
-
-
-
-
More
-
See Plugin Docs for how to use docsearch plugin and its available options.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/index.html.js
deleted file mode 100644
index 701e7c1..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/\",\"title\":\"Guide\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Guide\",\"icon\":\"lightbulb\",\"index\":false,\"category\":[\"Intro\"],\"tag\":[\"Intro\"],\"description\":\"Introduction VuePress Theme Hope is a VuePress theme containing tons of features. It is designed to be a powerful and extensible theme with a lot of theme plugins built-in. To b...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Guide\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Introduction VuePress Theme Hope is a VuePress theme containing tons of features. It is designed to be a powerful and extensible theme with a lot of theme plugins built-in. To b...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Guide\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Introduction\",\"slug\":\"introduction\",\"link\":\"#introduction\",\"children\":[]},{\"level\":2,\"title\":\"Asking for Help\",\"slug\":\"asking-for-help\",\"link\":\"#asking-for-help\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.79,\"words\":238},\"filePathRelative\":\"guide/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/index.html.vue
deleted file mode 100644
index 1a2c684..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/index.html.vue
+++ /dev/null
@@ -1,29 +0,0 @@
-
VuePress Theme Hope is a VuePress theme containing tons of features.
-
It is designed to be a powerful and extensible theme with a lot of theme plugins built-in.
-
To begin with, you should already have a basic understanding of:
-
-
Markdown (Including YAML Frontmatter concept)
-
VuePress Basic knowledge
-
-
-
Tips
-
-
-
If you are completely new to VuePress, Markdown and other things, please get started with our Step by Step Tutorial for newcomers.
-
-
-
If you are familiar with things above, get Started here.
-
-
-
-
-
A project with plugins and powerful theme
-
Although vuepress-theme-hope/vuepress-theme-hope itself marked as a theme repository, it also contains more than a dozen equally complete and powerful plugin. Each plugin is also powerful, can be used with the default theme or third-party themes.
-
Based on such a dozen plugins, Mr.Hope can confidently say that vuepress-theme-hope is "A powerful theme with tons of features". It can also be seen as the most versatile and comprehensive theme among all VuePress themes.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.js
deleted file mode 100644
index 455cf4e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/accessibility.html\",\"title\":\"A11y\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"A11y\",\"icon\":\"universal-access\",\"order\":-1,\"category\":[\"Interface\"],\"tag\":[\"A11y\",\"Interface\"],\"description\":\"\\\"A11y\\\" stands for \\\"accessibility\\\". The theme adds full support of accessibility. All page structures of the theme are processed semantically. All buttons and icons have their co...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/accessibility.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/accessibility.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/accessibility.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"A11y\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"\\\"A11y\\\" stands for \\\"accessibility\\\". The theme adds full support of accessibility. All page structures of the theme are processed semantically. All buttons and icons have their co...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"A11y\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"A11y\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.22,\"words\":67},\"filePathRelative\":\"guide/interface/accessibility.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.vue
deleted file mode 100644
index 8020a70..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/accessibility.html.vue
+++ /dev/null
@@ -1,17 +0,0 @@
-
"A11y" stands for "accessibility".
-
The theme adds full support of accessibility.
-
-
-
All page structures of the theme are processed semantically.
-
-
-
All buttons and icons have their corresponding accessibility labels
-
-
-
All main interactive elements can be focused and interacted through the keyboard
-
-
-
This is our support for the visually impaired people around the world! ❤️
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.js
deleted file mode 100644
index 4af2427..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/code-theme.html\",\"title\":\"Code Themes\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Code Themes\",\"icon\":\"wand-magic-sparkles\",\"order\":4,\"category\":[\"Interface\"],\"tag\":[\"Interface\",\"Code Themes\"],\"description\":\"With Prism.js Highlighter vuepress-theme-hope bundles @vuepress/plugin-prismjs to support code highlighting by default, and we allow you to set code block themes for lightmode a...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/code-theme.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/code-theme.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/code-theme.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Code Themes\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"With Prism.js Highlighter vuepress-theme-hope bundles @vuepress/plugin-prismjs to support code highlighting by default, and we allow you to set code block themes for lightmode a...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Code Themes\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Code Themes\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"With Prism.js Highlighter\",\"slug\":\"with-prism-js-highlighter\",\"link\":\"#with-prism-js-highlighter\",\"children\":[{\"level\":3,\"title\":\"Available Themes\",\"slug\":\"available-themes\",\"link\":\"#available-themes\",\"children\":[]}]},{\"level\":2,\"title\":\"With Shiki Highlighter\",\"slug\":\"with-shiki-highlighter\",\"link\":\"#with-shiki-highlighter\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.1,\"words\":329},\"filePathRelative\":\"guide/interface/code-theme.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.vue
deleted file mode 100644
index 9e04e6b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/code-theme.html.vue
+++ /dev/null
@@ -1,115 +0,0 @@
-
vuepress-theme-hope bundles @vuepress/plugin-prismjs to support code highlighting by default, and we allow you to set code block themes for lightmode and darkmode globally.
-
By default, we use one-light and one-dark for lightmode and darkmode respectively, and you can change them by setting light and dark in plugins.prismjs.
Prism.js is fast and lightweight, but it can not highlight all syntax correctly. If you want a more accurate highlight result, you can use @vuepress/plugin-shiki.
-
-
-
Disable @vuepress/plugin-prismjs plugin by setting plugins.prismjs: false in theme options.
Set background color and font color for code blocks according to theme you want to use by adding these variables in .vuepress/styles/config.scss:.
-
-
$code-bg-color: background color for code blocks
-
$code-color: font color for code blocks
-
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/darkmode.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/darkmode.html.js
deleted file mode 100644
index 597949f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/darkmode.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/darkmode.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/darkmode.html\",\"title\":\"Darkmode\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Darkmode\",\"icon\":\"circle-half-stroke\",\"order\":1,\"category\":[\"Interface\"],\"tag\":[\"Darkmode\",\"Interface\"],\"description\":\"In dark mode, the page uses a dark background to make you comfortable.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/darkmode.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/darkmode.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/darkmode.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Darkmode\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"In dark mode, the page uses a dark background to make you comfortable.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Darkmode\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Darkmode\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Try it\",\"slug\":\"try-it\",\"link\":\"#try-it\",\"children\":[]},{\"level\":2,\"title\":\"Options\",\"slug\":\"options\",\"link\":\"#options\",\"children\":[]},{\"level\":2,\"title\":\"Getting Status\",\"slug\":\"getting-status\",\"link\":\"#getting-status\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.54,\"words\":161},\"filePathRelative\":\"guide/interface/darkmode.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
In dark mode, the page uses a dark background to make you comfortable.
You can use $isDarkmode in Markdown files or Vue Template to get darkmode status.
-
-
-
You can import useDarkmode from vuepress-theme-hope/client to get darkmode status:
-
import { useDarkmode } from "vuepress-theme-hope/client";
-
-const { isDarkmode } = useDarkmode();
-
-console.log(isDarkmode.value); // get darkmode status
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/icon.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/icon.html.js
deleted file mode 100644
index 7ef978b..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/icon.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/icon.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/icon.html\",\"title\":\"Icon support\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Icon support\",\"icon\":\"icons\",\"order\":3,\"category\":[\"Interface\"],\"tag\":[\"Icon\",\"Interface\"],\"head\":[[\"link\",{\"rel\":\"stylesheet\",\"href\":\"//at.alicdn.com/t/c/font_2410206_5vb9zlyghj.css\"}],[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/icon.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/icon.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/icon.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Icon support\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The entire theme adds FontClass and Image format icon support in multiple places. You can use iconfont, iconify and fontawesome to add icons to your project, and you can also us...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Icon\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Icon support\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]],\"description\":\"The entire theme adds FontClass and Image format icon support in multiple places. You can use iconfont, iconify and fontawesome to add icons to your project, and you can also us...\"},\"headers\":[{\"level\":2,\"title\":\"Browsing Icon List\",\"slug\":\"browsing-icon-list\",\"link\":\"#browsing-icon-list\",\"children\":[]},{\"level\":2,\"title\":\"Setting Icons\",\"slug\":\"setting-icons\",\"link\":\"#setting-icons\",\"children\":[]},{\"level\":2,\"title\":\"Adding Icons in Markdown\",\"slug\":\"adding-icons-in-markdown\",\"link\":\"#adding-icons-in-markdown\",\"children\":[]},{\"level\":2,\"title\":\"Global Settings\",\"slug\":\"global-settings\",\"link\":\"#global-settings\",\"children\":[{\"level\":3,\"title\":\"Setting Icon Assets\",\"slug\":\"setting-icon-assets\",\"link\":\"#setting-icon-assets\",\"children\":[]},{\"level\":3,\"title\":\"Setting Icon Prefix\",\"slug\":\"setting-icon-prefix\",\"link\":\"#setting-icon-prefix\",\"children\":[]}]},{\"level\":2,\"title\":\"Advanced\",\"slug\":\"advanced\",\"link\":\"#advanced\",\"children\":[{\"level\":3,\"title\":\"Using Fontawesome Kits\",\"slug\":\"using-fontawesome-kits\",\"link\":\"#using-fontawesome-kits\",\"children\":[]},{\"level\":3,\"title\":\"Generate your own iconfont assets\",\"slug\":\"generate-your-own-iconfont-assets\",\"link\":\"#generate-your-own-iconfont-assets\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.42,\"words\":1026},\"filePathRelative\":\"guide/interface/icon.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The entire theme adds FontClass and Image format icon support in multiple places.
\\n
You can use iconfont, iconify and fontawesome to add icons to your project, and you can also use your own icon assets. Also, png/svg format icon is supported. You can use full links or pathname to add icons.
The entire theme adds FontClass and Image format icon support in multiple places.
-
You can use iconfont, iconify and fontawesome to add icons to your project, and you can also use your own icon assets. Also, png/svg format icon is supported. You can use full links or pathname to add icons.
To keep it simple, we add built-in keywords "iconify", "fontawesome" and "fontawesome-with-brand support for you to get started easily.
-
-
Caution
-
If you use this plugin for commercial project documentation, iconfont is not recommended as iconfont itself is a study/share platform for designers and developers.
-
Every icon is uploaded by users, and you must get authorized from the author for commercial usage. Also, there could be chance where the uploader obeys usage term. And upload icons where its copyright is at 3rd party.
iconPrefix is the icon prefix where you want to set,
-
Normally, there should be a common prefix for your icon class, for iconfont icon classes are iconfont icon-<ICON-NAME> and for fontawesome free icon classes are fas fa-<icon-name>. So when you are setting the above assets option with keywords or a single link generated from iconfont website, fontawesome kit or fontawesome CDN, the plugin recognize those and set prefix as "iconfont icon-" and "fas fa-" automatically for you.
-
In other cases where you use iconify or your own url, you can manually set this options yourself. After all writing icon: apple is always better than something like icon: iconfont icon-apple, icon: mdi:icon-apple or icon: fa-solid fa-apple.
Iconfont is a vector icon management and communication platform created by Alimama MUX.
-
The designer uploads the icon to the Iconfont platform, and the user can customize the download of icons in a variety of formats. Users can also convert the icon into a font.
First, you need to create a new project to set and manage your website's icons:
-
-
Log in to Iconfont using GitHub or Weibo.
-
Find "Resources → My Projects" at the top of the website, and click the "New Project" icon in the upper right corner.
-
Set a recognizable project name
-
Fill in FontClass/Symbol prefix with icon- (you can also fill in according to your preference, but you need to set this value to iconPrefix in theme options with an extra iconfont prefix)
Search freely through iconfont to find the icon you want to use, and click the "Add to Library" button on the icon
-Add to library
-
-
-
After searching for all the icons, click the "Add to Library" icon in the upper right corner, click "Add to Project" below and select the project you created then confirm.
On the project page, you can edit the icons in the project, including adjustments with position, size, rotate, color, Unicode number and Font Class / Symbol.
If you add a new icon in the future, please regenerate the new CSS address and set it to iconAssets in theme options.
-
-
-
Conflicts with private character
-
Font Icon associate each icon with a character in unicode private character scope, the character used by iconfont is randomly.
-
Iconfont will try to solve conflicts by assigning a new character if a new icon's default character is already used in current project, however different projects may have conflicts.
-
So we do not recommend you to use multiple iconfont links as assets, if you ready want to do so, check the icons to ensure every former project icon is not covered by those in latter ones.
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.js
deleted file mode 100644
index d7d3e41..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/\",\"title\":\"Interface\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Interface\",\"icon\":\"palette\",\"index\":false,\"dir\":{\"order\":2},\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Interface\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.04,\"words\":11},\"filePathRelative\":\"guide/interface/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\"}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.vue
deleted file mode 100644
index c6d50c0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/index.html.vue
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.js
deleted file mode 100644
index cea89f8..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/others.html\",\"title\":\"Other features\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Other features\",\"icon\":\"ellipsis\",\"order\":7,\"category\":[\"Interface\"],\"tag\":[\"Interface\"],\"description\":\"Print Button Try it: The theme fully optimize style for print, and there will be a print button at toc in desktop mode by default. To hide print button, you should set print: fa...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/others.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/others.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/others.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Other features\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Print Button Try it: The theme fully optimize style for print, and there will be a print button at toc in desktop mode by default. To hide print button, you should set print: fa...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Other features\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Print Button\",\"slug\":\"print-button\",\"link\":\"#print-button\",\"children\":[]},{\"level\":2,\"title\":\"Fullscreen Button\",\"slug\":\"fullscreen-button\",\"link\":\"#fullscreen-button\",\"children\":[]},{\"level\":2,\"title\":\"Back to top button\",\"slug\":\"back-to-top-button\",\"link\":\"#back-to-top-button\",\"children\":[]},{\"level\":2,\"title\":\"RTL Layout\",\"slug\":\"rtl-layout\",\"link\":\"#rtl-layout\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.06,\"words\":317},\"filePathRelative\":\"guide/interface/others.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.vue
deleted file mode 100644
index 97efaf2..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/others.html.vue
+++ /dev/null
@@ -1,81 +0,0 @@
-
vuepress-theme-hope adds a back-to-top button with progress bar using @vuepress/plugin-back-to-top which will display after scrolling down 100px by default.
-
You can set plugins.backToTop: false in theme options to disable it, or set it with an object to customize its threshold distance and progress bar display:
-
import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-export default defineUserConfig({
- theme: hopeTheme({
- plugins: {
- // disable back to top button
- backToTop: false,
-
- // or
-
- // customize back to top button
- backToTop: {
- /**
- * Scroll threshold distance to display back to top button (in pixels)
- *
- * @default 100
- */
- threshold: 500,
- /**
- * Whether display scroll progress
- *
- * @default true
- */
- progress: false,
- },
- },
- }),
-});
-
-
-
-
\ No newline at end of file
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.js
deleted file mode 100644
index f08bda3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/pure.html\",\"title\":\"Pure Mode\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Pure Mode\",\"icon\":\"leaf\",\"order\":-2,\"category\":[\"Interface\"],\"tag\":[\"Interface\"],\"description\":\"If your site is a documentation-only site, and you prefer a clean style, you can enable pure mode by setting pure: true in theme options. In this mode, we disable some fancy ani...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/pure.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/pure.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/pure.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Pure Mode\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"If your site is a documentation-only site, and you prefer a clean style, you can enable pure mode by setting pure: true in theme options. In this mode, we disable some fancy ani...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Pure Mode\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.23,\"words\":68},\"filePathRelative\":\"guide/interface/pure.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.vue
deleted file mode 100644
index dae898f..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/pure.html.vue
+++ /dev/null
@@ -1,12 +0,0 @@
-
If your site is a documentation-only site, and you prefer a clean style, you can enable pure mode by setting pure: true in theme options.
In this mode, we disable some fancy animations and some colors and just provide functionality.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/responsive.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/responsive.html.js
deleted file mode 100644
index b9e9d3e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/responsive.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/responsive.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/responsive.html\",\"title\":\"Responsive Layout\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Responsive Layout\",\"icon\":\"grip\",\"order\":5,\"category\":[\"Interface\"],\"tag\":[\"Interface\",\"Responsive layout\"],\"description\":\"The whole theme is responsive, which means it works well on different screen sizes.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/responsive.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/responsive.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/responsive.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Responsive Layout\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The whole theme is responsive, which means it works well on different screen sizes.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Responsive layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Responsive Layout\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Introduction to Responsive Layout\",\"slug\":\"introduction-to-responsive-layout\",\"link\":\"#introduction-to-responsive-layout\",\"children\":[]},{\"level\":2,\"title\":\"Responsive configuration\",\"slug\":\"responsive-configuration\",\"link\":\"#responsive-configuration\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.92,\"words\":276},\"filePathRelative\":\"guide/interface/responsive.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The whole theme is responsive, which means it works well on different screen sizes.
In navbar, site name will be hidden, and elements such as navbar links, theme switch, and full-screen button will be collapsed into additional pop-up window, and toggled through the button on the right side of navbar;
-
The sidebar will be displayed in the form of a side menu and hidden by default, and the sidebar toggle button is displayed on the left side of navbar to control the pop-up and retraction of the sidebar;
-
Path navigation, body text, back to top button text has smaller font size
-
The title of the current page is collapsed into the sidebar
-
-
On tablet/laptop devices:
-
-
Navbar links will appear in the navbar
-
The sidebar will be displayed as a collapsible menu
-
The title of the current page is collapsed into the sidebar
-
-
On pc device:
-
-
Navbar links will appear in the navbar
-
The sidebar will stick to the left side of the content on the page
-
The title of the current page will be displayed on the right side of the page
Themes provide breakpoint variables for controlling responsive layout behavior. You can modify them in .vuepress/styles/config.scss:
-
-
$pc: PC responsive layout breakpoint, default is 1440px
-
$laptop: notebook responsive layout breakpoint, default is 1280px
-
$pad: Large pad responsive layout breakpoint, defaults to 959px
-
$tablet: Tablet responsive layout breakpoint, default is 768px
-
$mobile: Mobile responsive layout breakpoint, default is 480px
-
-
-
Warning
-
$tablet and $pc can only be based on the pixel size.
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/interface/theme-color.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/interface/theme-color.html.js
deleted file mode 100644
index a373ef3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/interface/theme-color.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/interface/theme-color.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/interface/theme-color.html\",\"title\":\"Theme Color\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme Color\",\"icon\":\"palette\",\"order\":2,\"category\":[\"Interface\"],\"tag\":[\"Interface\",\"Theme Color\"],\"description\":\"The theme allows you to customize theme color and even provide a picker.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/interface/theme-color.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/interface/theme-color.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/interface/theme-color.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme Color\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme allows you to customize theme color and even provide a picker.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Interface\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Theme Color\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme Color\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Setting Default Theme Color\",\"slug\":\"setting-default-theme-color\",\"link\":\"#setting-default-theme-color\",\"children\":[]},{\"level\":2,\"title\":\"Theme Color Picker\",\"slug\":\"theme-color-picker-title\",\"link\":\"#theme-color-picker-title\",\"children\":[{\"level\":3,\"title\":\"Try it\",\"slug\":\"try-it\",\"link\":\"#try-it\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.46,\"words\":137},\"filePathRelative\":\"guide/interface/theme-color.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme allows you to customize theme color and even provide a picker.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.js
deleted file mode 100644
index 16e7666..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/intro/intro.html\",\"title\":\"Theme intro\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Theme intro\",\"icon\":\"circle-info\",\"star\":true,\"order\":1,\"category\":[\"Get Started\"],\"tag\":[\"Get Started\",\"Intro\"],\"description\":\"Original Intention VuePress extends Markdown syntax to a certain extent, but it still lacks some commonly used functions, such as text alignment, mark, flowchart, formula, prese...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/intro/intro.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/intro/intro.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/intro/intro.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Theme intro\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Original Intention VuePress extends Markdown syntax to a certain extent, but it still lacks some commonly used functions, such as text alignment, mark, flowchart, formula, prese...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Get Started\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Intro\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Theme intro\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Original Intention\",\"slug\":\"original-intention\",\"link\":\"#original-intention\",\"children\":[]},{\"level\":2,\"title\":\"Design Goals\",\"slug\":\"design-goals\",\"link\":\"#design-goals\",\"children\":[]},{\"level\":2,\"title\":\"Why Powerful\",\"slug\":\"why-powerful\",\"link\":\"#why-powerful\",\"children\":[{\"level\":3,\"title\":\"Content Richness\",\"slug\":\"content-richness\",\"link\":\"#content-richness\",\"children\":[]},{\"level\":3,\"title\":\"UI Improvements\",\"slug\":\"ui-improvements\",\"link\":\"#ui-improvements\",\"children\":[]},{\"level\":3,\"title\":\"Layouts Improvement\",\"slug\":\"layouts-improvement\",\"link\":\"#layouts-improvement\",\"children\":[]},{\"level\":3,\"title\":\"Page Meta\",\"slug\":\"page-meta\",\"link\":\"#page-meta\",\"children\":[]},{\"level\":3,\"title\":\"New Features\",\"slug\":\"new-features\",\"link\":\"#new-features\",\"children\":[]},{\"level\":3,\"title\":\"Blog Support\",\"slug\":\"blog-support\",\"link\":\"#blog-support\",\"children\":[]}]},{\"level\":2,\"title\":\"Build-in Plugins🧩\",\"slug\":\"build-in-plugins🧩\",\"link\":\"#build-in-plugins🧩\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":2.93,\"words\":880},\"filePathRelative\":\"guide/intro/intro.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.vue
deleted file mode 100644
index 3633c29..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/intro/intro.html.vue
+++ /dev/null
@@ -1,189 +0,0 @@
-
VuePress extends Markdown syntax to a certain extent, but it still lacks some commonly used functions, such as text alignment, mark, flowchart, formula, presentation, etc. At the same time, some features provided by the default theme are weak or missing, such as picture preview, code block copy, toc, etc. Meanwhile, VuePress default theme is too simple and not powerful enough. vuepress-theme-hope and related plugins were born under this situation.
-
We not only greatly improve outlook comparing to default theme, but also provide a full range of enhancements for VuePress with theme plugins.
The theme provides a lot of extended syntax support for Markdown, allowing you to insert more content in the body.
-
-
-
We have some built-in enhancement with images.
-
-
-
If you are a literature lover and want to place some essays, the theme provides Custom Alignment and footnote.
-
-
-
To store some knowledge notes, the theme provides Custom container, Mark, Task listmindmap and Tex support.
-
-
-
If you are a programmer and need to show a lot of codes and demos, this theme provides light and dark themes for code blocks, code tabs and the "one-click copy" button. At the same time, we also provide the Code Demo, Playground, Kotlin Playground and Vue Playground functions, which is convenient for you to show your own Vue, React components or other demos and provide playground for visitors.
-
-
-
If you are providing product documentation and presentation, the theme provides tabs, slide, chart, echarts, flowchart, mermaid diagram and plantuml functions.
-
-
-
To reorganize your content, the theme provides File Include function.
-
-
-
To style your content, the theme provides Subscript and Superscript, Attrs setting and Stylize function.
-
-
-
The theme also provides you a lot of useful components.
-
-
-
In short, anyone can enjoy the convenience of Markdown's enhanced syntax.
The theme includes the following plugins, you can use them in other themes or directly.
-
-
-vuepress-plugin-components: Provide some out of box plugins
-
-vuepress-plugin-md-enhance: Provide more Markdown syntax
-
-vuepress-plugin-sass-palette: Sass style plugin for all plugins and themes
-
-
-
Tips
-
Here are some other plugins that are not bundled by the theme, you can enable them according to your own needs.
-
-
-vuepress-plugin-lightgallery: Image preview plugin based on lightgallery
-
-vuepress-plugin-search-pro: Client search plugin
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/intro/markdown.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/intro/markdown.html.js
deleted file mode 100644
index 37be04a..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/intro/markdown.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/intro/markdown.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/intro/markdown.html\",\"title\":\"Markdown\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Markdown\",\"icon\":\"fab fa-markdown\",\"order\":3,\"category\":[\"Get Started\"],\"tag\":[\"Get Started\",\"Markdown\"],\"description\":\"VuePress basically generate pages from Markdown files. So you can use it to generate documentation or blog sites easily. You should create and write Markdown files, so that VueP...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/intro/markdown.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/intro/markdown.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/intro/markdown.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"VuePress basically generate pages from Markdown files. So you can use it to generate documentation or blog sites easily. You should create and write Markdown files, so that VueP...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Get Started\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Markdown\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Markdown Config\",\"slug\":\"markdown-config\",\"link\":\"#markdown-config\",\"children\":[]},{\"level\":2,\"title\":\"Markdown Extensions\",\"slug\":\"markdown-extensions\",\"link\":\"#markdown-extensions\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.65,\"words\":196},\"filePathRelative\":\"guide/intro/markdown.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
VuePress basically generate pages from Markdown files. So you can use it to generate documentation or blog sites easily.
\\n
You should create and write Markdown files, so that VuePress can convert them to different pages according to file structure.
The Markdown content in VuePress will be parsed by markdown-it, which supports syntax extensions via markdown-it plugins.
-
-
-
VuePress Enhancement
-
To enrich document content, VuePress extends standard Markdown syntax, read Built-in Markdown Features for details.
-
-
-
Theme Enhancement
-
With vuepress-plugin-md-enhance, the theme extends more Markdown syntax, see Theme Enhancement for details.
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/breadcrumb.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/breadcrumb.html.js
deleted file mode 100644
index f435690..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/breadcrumb.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/breadcrumb.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/breadcrumb.html\",\"title\":\"Path Navigation\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Path Navigation\",\"icon\":\"bars-progress\",\"order\":3,\"category\":[\"Layout\"],\"tag\":[\"Breadcrumb\",\"Layout\"],\"description\":\"The theme adds Breadcrumb support, you can configure it using breadcrumb in page frontmatter and theme options Without any config, a Breadcrumb that matches the theme color is d...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/breadcrumb.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/breadcrumb.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/breadcrumb.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Path Navigation\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The theme adds Breadcrumb support, you can configure it using breadcrumb in page frontmatter and theme options Without any config, a Breadcrumb that matches the theme color is d...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Breadcrumb\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Path Navigation\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.77,\"words\":232},\"filePathRelative\":\"guide/layout/breadcrumb.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The theme adds Breadcrumb support, you can configure it using breadcrumb in page frontmatter and theme options
\\n
Without any config, a Breadcrumb that matches the theme color is displayed at the top of the page content to help the reader understand the document structure.
The theme adds Breadcrumb support, you can configure it using breadcrumb in page frontmatter and theme options [1], the default value is true.
-
Without any config, a Breadcrumb that matches the theme color is displayed at the top of the page content to help the reader understand the document structure.
-
-
You can also control the icon display of the path navigation using breadcrumbIcon field , the default value is true.
-
If you don't want a page to be added to the breadcrumb (e.g.: home page), you can set breadcrumbExclude: true in the Front Matter of the page.
-
-
-
-
Page config support
-
Support local configuration means that the theme allows the configuration of the page to override the global configuration.
-Example
-
Take path navigation as an example:
-
This feature is enabled globally by default, that is, breadcrumb in theme options is true by default, and you can set breadcrumb: false in the Front Matter of a specific page to disable it locally.
-
Of course, you can also set the breadcrumb: false in theme options to disable it globally, and set breadcrumb: true in the Front Matter of a specific page to enable it locally.
The copyright field is used as copyright information of a specific page (useful when you cite an article and the article uses a specific license). It also supports HTMLString.
-
The default copyright text will be generated from author and license in theme options.
-
When setting displayFooter: true in theme options, you can also set copyright: false to hide the copyright information in a specific page.
When you set displayFooter: true in theme options, you can also disable it locally:
-
---
-footer: false
----
-
-
-
To remove the default footer content while keeping copyright information displayed, please use an empty string.
-
---
-footer: ""
----
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/home.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/home.html.js
deleted file mode 100644
index a956e19..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/home.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/home.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/home.html\",\"title\":\"Home Page\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Home Page\",\"icon\":\"home\",\"order\":7,\"category\":[\"Layout\"],\"tag\":[\"Home\",\"Layout\"],\"description\":\"vuepress-theme-hope improves the default home page. To use it, set home: true in page frontmatter. Any extra content after the YAML front matter will be parsed as normal Markdow...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/home.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/home.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/home.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Home Page\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope improves the default home page. To use it, set home: true in page frontmatter. Any extra content after the YAML front matter will be parsed as normal Markdow...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Home\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Home Page\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Site Information\",\"slug\":\"site-information\",\"link\":\"#site-information\",\"children\":[]},{\"level\":2,\"title\":\"Home button\",\"slug\":\"home-button\",\"link\":\"#home-button\",\"children\":[]},{\"level\":2,\"title\":\"Project features (legacy)\",\"slug\":\"project-features-legacy\",\"link\":\"#project-features-legacy\",\"children\":[]},{\"level\":2,\"title\":\"Project Highlights and features\",\"slug\":\"project-highlights-and-features\",\"link\":\"#project-highlights-and-features\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.69,\"words\":506},\"filePathRelative\":\"guide/layout/home.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope improves the default home page.
\\n
To use it, set home: true in page frontmatter. Any extra content after the YAML front matter will be parsed as normal Markdown and rendered after the features section.
vuepress-theme-hope improves the default home page.
-
To use it, set home: true in page frontmatter. Any extra content after the YAML front matter will be parsed as normal Markdown and rendered after the features section.
You can use heroText to set the main title and tagline to set the subtitle.
-
If you have a logo, you can place it in the public folder and set it via heroImage, if you want to display another logo in night mode, you can use heroImageDark. For better A11y, we recommend that you set the description of Logo to heroAlt.
-
You can set the background image through bgImage and bgImageDark, but you need to pay attention that you must fill in the full URL or absolute path. If you want the information to be displayed in full screen, you can set heroFullScreen: true.
-
If you need to customize some styles, you can set the style of the logo and background image through heroImageStyle and bgImageStyle.
You can set and display project features and highlights through highlights, which is an array, each element is an object, representing a highlight or feature section.
-
Highlight section use highlights to set highlights and feature section use features to set features (you should only set one of them). Both of them are arrays, each element is an object, representing a highlight or feature item:
-
-
title: title, HTML string is supported
-
details: details, HTML string is supported
-
icon (optional): can be filled with full path or absolute path image link, or FontClass
-
link (optional): link address
-
-
You can also set the following optional keys:
-
-
header: section title, supports HTML string
-
description: section description, supports HTML string
-
color: Text color
-
image: Section image
-
imageDark: Section image used in darkmode
-
bgImage: Section background image
-
bgImageDark: Section background image used in darkmode
-
bgImageStyle: Section background image styles
-
-
Highlights also support the following properties:
-
-
type: "order", "un-order"(default) or "no-order"
-
-
-
Info
-
For complete configuration items, see Home Frontmatter Configuration.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.js
deleted file mode 100644
index 4508d59..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/\",\"title\":\"Layout\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Layout\",\"icon\":\"object-group\",\"dir\":{\"order\":5},\"index\":false,\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Layout\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.04,\"words\":12},\"filePathRelative\":\"guide/layout/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\"}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.vue
deleted file mode 100644
index c6d50c0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/index.html.vue
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/navbar.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/navbar.html.js
deleted file mode 100644
index 77abea3..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/navbar.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/navbar.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/navbar.html\",\"title\":\"NavBar\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"NavBar\",\"icon\":\"window-maximize\",\"order\":1,\"category\":[\"Layout\"],\"tag\":[\"Layout\",\"Navbar\"],\"description\":\"The Navbar contains: Site title Search Box Navbar Links Language dropdown Repository Link Outlook Popup All of them are customizable, and you can also fully customize Navbar lay...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/navbar.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/navbar.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/navbar.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"NavBar\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The Navbar contains: Site title Search Box Navbar Links Language dropdown Repository Link Outlook Popup All of them are customizable, and you can also fully customize Navbar lay...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Navbar\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"NavBar\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Navbar Links\",\"slug\":\"navbar-links\",\"link\":\"#navbar-links\",\"children\":[{\"level\":3,\"title\":\"String Format\",\"slug\":\"string-format\",\"link\":\"#string-format\",\"children\":[]},{\"level\":3,\"title\":\"Object Format\",\"slug\":\"object-format\",\"link\":\"#object-format\",\"children\":[]},{\"level\":3,\"title\":\"Dropdown List\",\"slug\":\"dropdown-list\",\"link\":\"#dropdown-list\",\"children\":[]}]},{\"level\":2,\"title\":\"Disable Navbar\",\"slug\":\"disable-navbar\",\"link\":\"#disable-navbar\",\"children\":[]},{\"level\":2,\"title\":\"Site Logo\",\"slug\":\"site-logo\",\"link\":\"#site-logo\",\"children\":[]},{\"level\":2,\"title\":\"I18n Support\",\"slug\":\"i18n-support\",\"link\":\"#i18n-support\",\"children\":[]},{\"level\":2,\"title\":\"Search Box\",\"slug\":\"search-box\",\"link\":\"#search-box\",\"children\":[]},{\"level\":2,\"title\":\"Git Repository and Edit Links\",\"slug\":\"git-repository-and-edit-links\",\"link\":\"#git-repository-and-edit-links\",\"children\":[]},{\"level\":2,\"title\":\"Outlook Popup\",\"slug\":\"outlook-popup\",\"link\":\"#outlook-popup\",\"children\":[]},{\"level\":2,\"title\":\"Layout config\",\"slug\":\"layout-config\",\"link\":\"#layout-config\",\"children\":[]},{\"level\":2,\"title\":\"Types and Helpers\",\"slug\":\"types-and-helpers\",\"link\":\"#types-and-helpers\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":3.62,\"words\":1086},\"filePathRelative\":\"guide/layout/navbar.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The easiest way to configure the navbar is to fill in the paths of the page files to be displayed in turn, so that the text, icons and links of the item will be automatically generated from the corresponding files.
If you are not satisfied with the page's icon or feel that the page title is too long, you can configure an object instead. Available configuration items are:
-
-
text:: item text
-
link: item link
-
icon: item icon (optional)
-
activeMatch: item active math (optional), support regexp strings
-
-
import { hopeTheme } from "vuepress-theme-hope";
-
-export default {
- theme: hopeTheme({
- navbar: [
- {
- text: "Guide",
- link: "/guide/README.md",
- icon: "lightbulb",
- // only active in `/guide/`
- activeMatch: "^/guide/$",
- },
- { text: "Config", link: "/config/README.md", icon: "config" },
- {
- text: "FAQ",
- link: "/faq.md",
- icon: "circle-question",
- // active in path starting with `/faq`
- // so it will active in path like `/faq/xxx.html`
- activeMatch: "^/zh/faq/",
- },
- ],
- }),
-};
-
-
Advanced usage of activeMatch
-
activeMatch gives you the ability to control whether the path is active, for example you may have the following dropdown:
-
-
/path/
-
/path/a/
-
/path/b/
-
-
But you may have multiple folders with files under /path/. To avoid multiple dropdown items been activated under route starting with /path/a/ or /path/b/, you can set activeMatch option for the first item with ^/path/(?:(?!a/|b/).*)?$.
In most cases, the grouped items in the navbar belong to the same category and will be placed in the same subdirectory, and they have the same path prefix.
-
To simplify the configuration, you can add the prefix field to add a prefix to each sub-link in the group:
Like the default theme, vuepress-theme-hope brings built-in support for search plugins. You can enable the following plugins according to your own needs. The corresponding search box will automatically appear in the navbar.
vuepress-theme-hope exports the type of navbar as NavbarConfig, and provides a navbar helper function. They can provide validation and autocompletion of navbar configuration in TS and JS.
-
-
Tips
-
They mainly deal with scenarios when you split your VuePress configuration into multiple parts.
-
-
-TS Helper
-TS Type
-JS
-
-
import { navbar } from "vuepress-theme-hope";
-
-export default navbar([
- /* Your navbar configuration */
-]);
-
-
-
import type { NavbarConfig } from "vuepress-theme-hope";
-
-const navbarConfig: NavbarConfig = [
- /* Your navbar configuration */
-];
-
-export default navbarConfig;
-
-
-
import { navbar } from "vuepress-theme-hope";
-
-export default navbar([
- /* Your navbar configuration */
-]);
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.js
deleted file mode 100644
index 0f5cb1e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/page.html\",\"title\":\"Page\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Page\",\"icon\":\"file\",\"order\":5,\"category\":[\"Layout\"],\"tag\":[\"Page\",\"Layout\"],\"description\":\"Icon Support You can configure the icon field in the frontmatter of the page, and fill in the FontClass of the corresponding icon to bind the icon to the page. This icon is used...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/page.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/page.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/page.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Page\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Icon Support You can configure the icon field in the frontmatter of the page, and fill in the FontClass of the corresponding icon to bind the icon to the page. This icon is used...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Page\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Page\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Icon Support\",\"slug\":\"icon-support\",\"link\":\"#icon-support\",\"children\":[]},{\"level\":2,\"title\":\"Page Info Display\",\"slug\":\"page-info-display\",\"link\":\"#page-info-display\",\"children\":[]},{\"level\":2,\"title\":\"Breadcrumb\",\"slug\":\"breadcrumb\",\"link\":\"#breadcrumb\",\"children\":[]},{\"level\":2,\"title\":\"Header List\",\"slug\":\"header-list\",\"link\":\"#header-list\",\"children\":[{\"level\":3,\"title\":\"Setting header depth\",\"slug\":\"setting-header-depth\",\"link\":\"#setting-header-depth\",\"children\":[]}]},{\"level\":2,\"title\":\"Contributors and Last Updated Time\",\"slug\":\"contributors-and-last-updated-time\",\"link\":\"#contributors-and-last-updated-time\",\"children\":[]},{\"level\":2,\"title\":\"Prev / Next Links\",\"slug\":\"prev-next-links\",\"link\":\"#prev-next-links\",\"children\":[]},{\"level\":2,\"title\":\"Comment\",\"slug\":\"comment\",\"link\":\"#comment\",\"children\":[]},{\"level\":2,\"title\":\"Customize Layout\",\"slug\":\"customize-layout\",\"link\":\"#customize-layout\",\"children\":[]},{\"level\":2,\"title\":\"Customize Container Class\",\"slug\":\"customize-container-class\",\"link\":\"#customize-container-class\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":1.5,\"words\":451},\"filePathRelative\":\"guide/layout/page.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.vue
deleted file mode 100644
index 7423655..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/page.html.vue
+++ /dev/null
@@ -1,63 +0,0 @@
-
In desktop mode, a list of article headers will automatically be displayed on the right side of the screen. (They will be placed in the sidebar on mobile devices)
-
If you don't want to display the title list on the right in desktop mode, please set toc: false in theme options.
-
You can also set it through toc in page frontmatter.
Prev and next links are automatically inferred based on the sidebar order of the active page. You can also explicitly overwrite or disable them globally with theme config or on specific pages using Front matter:
By default, the content of each *.md file is rendered in a <div class="page"> container, along with the sidebar, auto-generated edit links and previous/next links. To use a fully custom component in place of the page, you can again specify the component using frontmatter:
-
---
-layout: SpecialLayout
----
-
This will render SpecialLayout layout registered in VuePress for the given page.
-
-
Note
-
The theme only provides Layout, 404 layout.
-
Also the theme:
-
-
Provides a Blog layout when the blogging feature is enabled
-
Provides a Slide layout when the slideshow feature is enabled
By default, each page is rendered in a div with class theme-container. To apply some special styles to specific pages, you can additionally specify a class name by setting containerClass in frontmatter
-
---
-containerClass: fancy-container
----
-
This will render in <div class="theme-container fancy-container" /> for the current page.
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/sidebar.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/sidebar.html.js
deleted file mode 100644
index 5806db0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/sidebar.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/sidebar.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/sidebar.html\",\"title\":\"Sidebar\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Sidebar\",\"icon\":\"fas fa-window-maximize fa-rotate-270\",\"order\":2,\"category\":[\"Layout\"],\"tag\":[\"Layout\",\"Sidebar\"],\"description\":\"The sidebar contains list of related documents, document titles, and blogger information in blog mode. The theme allows you to generate side bar from file structure or headers a...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/sidebar.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/sidebar.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/sidebar.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Sidebar\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"The sidebar contains list of related documents, document titles, and blogger information in blog mode. The theme allows you to generate side bar from file structure or headers a...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Sidebar\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Sidebar\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Sidebar Links\",\"slug\":\"sidebar-links\",\"link\":\"#sidebar-links\",\"children\":[{\"level\":3,\"title\":\"String Format\",\"slug\":\"string-format\",\"link\":\"#string-format\",\"children\":[]},{\"level\":3,\"title\":\"Object Format\",\"slug\":\"object-format\",\"link\":\"#object-format\",\"children\":[]},{\"level\":3,\"title\":\"Grouping and Nesting\",\"slug\":\"grouping-and-nesting\",\"link\":\"#grouping-and-nesting\",\"children\":[]},{\"level\":3,\"title\":\"Multiple Sidebars\",\"slug\":\"multiple-sidebars\",\"link\":\"#multiple-sidebars\",\"children\":[]}]},{\"level\":2,\"title\":\"Generate Sidebar from File Structure\",\"slug\":\"generate-sidebar-from-file-structure\",\"link\":\"#generate-sidebar-from-file-structure\",\"children\":[{\"level\":3,\"title\":\"Advanced Control\",\"slug\":\"advanced-control\",\"link\":\"#advanced-control\",\"children\":[]},{\"level\":3,\"title\":\"Disabling Sidebar\",\"slug\":\"disabling-sidebar\",\"link\":\"#disabling-sidebar\",\"children\":[]}]},{\"level\":2,\"title\":\"Header Links Depths\",\"slug\":\"header-links-depths\",\"link\":\"#header-links-depths\",\"children\":[{\"level\":3,\"title\":\"Active Header Links\",\"slug\":\"active-header-links\",\"link\":\"#active-header-links\",\"children\":[]}]},{\"level\":2,\"title\":\"I18n Support\",\"slug\":\"i18n-support\",\"link\":\"#i18n-support\",\"children\":[]},{\"level\":2,\"title\":\"Types and Helpers\",\"slug\":\"types-and-helpers\",\"link\":\"#types-and-helpers\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":6.41,\"words\":1922},\"filePathRelative\":\"guide/layout/sidebar.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
The sidebar contains list of related documents, document titles, and blogger information in blog mode.
\\n\\n
The theme allows you to generate side bar from file structure or headers automatically, or you can customize it manually.
Just like navbar, if you are not satisfied with the page's icon or feel that the page title is too long, you can configure an object instead. Available configuration items are:
-
-
text:: item text
-
link: item link
-
icon: item icon (optional)
-
activeMatch: item active math (optional), support regexp strings
-
-
import { hopeTheme } from "vuepress-theme-hope";
-
-export default {
- theme: hopeTheme({
- sidebar: [
- {
- text: "Guide",
- link: "/guide/README.md",
- icon: "lightbulb",
- // only active in `/guide/`
- activeMatch: "^/guide/$",
- },
- { text: "Config", link: "/config/README.md", icon: "config" },
- {
- text: "FAQ",
- link: "/faq.md",
- icon: "circle-question",
- // active in path starting with `/faq`
- // so it will active in path like `/faq/xxx.html`
- activeMatch: "^/zh/faq/",
- },
- ],
- }),
-};
-
-
Advanced usage of activeMatch
-
activeMatch gives you the ability to control whether the path is active, for example you may have the following dropdown:
-
-
/path/
-
/path/a/
-
/path/b/
-
-
But you may have multiple folders with files under /path/. To avoid multiple dropdown items been activated under route starting with /path/a/ or /path/b/, you can set activeMatch option for the first item with ^/path/(?:(?!a/|b/).*)?$.
If you need a sidebar that displays a nested structure, you can group similar links.
-
You should use object format and provide an additional children option to set the list of links. Like navbar, you can use prefix in the sidebar to add a default path prefix to each link in the group, and the sidebar additionally supports setting collapsible: true to make the menu group collapsible.
-
import { hopeTheme } from "vuepress-theme-hope";
-
-export default {
- theme: hopeTheme({
- sidebar: [
- {
- // required, title of group
- text: "Group 1",
- // optional, icon of group
- icon: "tip",
- // optional, link of group title
- path: "/foo/",
- // optional, will be appended to each item link
- prefix: "/foo/",
- // optional, defaults to false
- collapsible: false,
- // required, items of group
- children: [
- "README.md" /* /foo/index.html */,
- /* ... */
- "geo.md" /* /foo/geo.html */,
- ],
- },
- {
- text: "Group 2",
- children: [
- /* ... */
- "bar.md" /* /ray/bar.html */,
- "baz.md" /* /ray/baz.html */,
- ],
- },
- ],
- }),
-};
-
You need to pay special attention to the order of object key declaration. Generally speaking, you should put the more precise path first, because VuePress will traverse the key names of the sidebar configuration to find the matching configuration. Once a key name is successfully matched with the current path, it will display the corresponding sidebar configuration.
-
In this case, the fallback sidebar must be defined last for this reason.
You can replace the original "sidebarConfig array" with "structure" keyword in any of the above sidebar config. This will allow the theme to automatically read local files, then generate sidebar from file structure for you, to reduce your config workload.
-
For example, for the following example mentioned earlier in multiple sidebars:
In the above modification, since the original sidebar array is all files under the relevant path, you can easily replace it with the "structure" keyword.
-
If you use the structure to generate a folder with other folders nested under it, the corresponding folder will be rendered as a group. So you can even be more aggressive, for example setting sidebar: "structure" to have your sidebars all auto-generated from the file structure.
-
-
Limitations
-
Since structure sidebar is depending on file structure and markdown frontmatter, any changes in markdown may update the structure sidebar. (E.g: setting index: false in frontmatter as described below)
-
However, recalculating the sidebar could be expensive for large sites, so the theme will only recalculate with hotReload enabled.
During the automatic generation from structure, you can control whether files in the same folder are included through the index option in the page Frontmatter, and control how they are sorted through order.
-
When you don't want the page to be included in the sidebar, you need to set index: false in Frontmatter.
-
By default, the sidebar will be sorted according to the current language according to the title text of the file name. You can control how they are sorted by order. When you set a positive number, they will appear at the front of the group, the smaller the more forward, when you set a negative number, it will appear at the back of the group, and the larger the more backward:
-
-
page -> order: 1
-
page -> order: 2
-
page -> order: 3
-
...
-
pages with positive order will be sorted by order here
-
...
-
page without order option -> title: Axxx
-
...
-
pages without order option will be sorted by title here
-
...
-
page without order option -> title: Zxxx
-
...
-
pages with negative order will be sorted by order here
-
...
-
page -> order: -3
-
page -> order: -2
-
page -> order: -1
-
-
-
Tips
-
README.md is an exception, as long as you don't disable it from the sidebar via index: false or make it as group link, it will always be the first item after sorting.
-
-
For nested folders, the grouping information is controlled by README.md under that folder. You can control the behavior of folder grouping through the dir option in Frontmatter. The relevant optional items are as follows:
-
-
dir.text: Directory title, default to README.md title
-
dir.icon: Directory icon, default to README.md icon
-
dir.collapsible: Whether the directory is collapsible, default to true
-
dir.link: Whether the directory is clickable, default to false
-
dir.index: Whether index current dir, default to true
-
dir.order: Dir order in sidebar, default to 0
-
-
Here is an example:
-
---
-dir:
- order: 1
- text: Group 1
----
-
If no README.md file exists for the corresponding folder, only the group header will be generated from the folder name.
In addition to the above implementation, we also added a more powerful sidebarSorter option to the theme options. You can pass one or a series of built-in sorter names, or you can pass a sorter function you need to sort sidebar items at the same level.
-
Available keywords are:
-
-
readme: README.md or readme.md first
-
order: positive order first with its value ascending, negative order last with its value descending
-
date: sort by date ascending
-
date-desc: sort by date descending
-
title: alphabetically sort by title
-
filename: alphabetically sort by filename
-
-
Corresponding to the above advanced control, its default value is ["readme", "order", "title", "filename"]
The sidebar automatically displays links for headers in the current active page, nested under the link for the page itself. You can customize this behavior using headerDepth in theme options. The default depth(the max value) is 2, which extracts both h2 and h3 headers. Setting it to 0 disables the header links.
-
A page can also override this value via frontmatter:
-
---
-headerDepth: 2
----
-
-
Note
-
The valid maximum value depends on which levels of headers you have extracted via markdown.headers.level.
-
Since the default value of markdown.headers.level is [2, 3], so The default maximum value for headerDepth is 2.
By default, the nested header links and the hash in the URL are updated as the user scrolls to view the different sections of the page. This behavior can be disabled with the following theme config:
vuepress-theme-hope exports the type of sidebar as SideConfig, and provides a sidebar helper function. They can provide validation and autocompletion of sidebar configuration in TS and JS.
-
-
Tips
-
To deal with the situation when you split multi-sidebar configuration into multiple parts, we also provide SidebarArrayConfigSidebarObjectConfig type and arraySidebar and objectSidebar Helper function.
-
-
-TS Helper
-TS Types
-JS
-
-
import { sidebar } from "vuepress-theme-hope";
-
-export default sidebar(/* Your sidebar configuration */);
-
-
-
import type { SidebarConfig } from "vuepress-theme-hope";
-
-const sidebarConfig: SidebarConfig = [
- /* Your sidebar configuration */
-];
-
-export default sidebarConfig;
-
-
-
import { sidebar } from "vuepress-theme-hope";
-
-export default sidebar(/* Your sidebar configuration */);
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/layout/slides.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/layout/slides.html.js
deleted file mode 100644
index 27466bf..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/layout/slides.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/layout/slides.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/layout/slides.html\",\"title\":\"Slide\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Slide\",\"icon\":\"person-chalkboard\",\"order\":8,\"category\":[\"Layout\"],\"tag\":[\"Layout\",\"Slides\"],\"description\":\"vuepress-theme-hope allows you to add slides pages. You need to set layout: Slide in the frontmatter of the corresponding page to enable the slides page.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/layout/slides.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/layout/slides.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/layout/slides.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Slide\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"vuepress-theme-hope allows you to add slides pages. You need to set layout: Slide in the frontmatter of the corresponding page to enable the slides page.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Layout\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Slides\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Slide\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]},{\"level\":2,\"title\":\"Attention\",\"slug\":\"attention\",\"link\":\"#attention\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.42,\"words\":125},\"filePathRelative\":\"guide/layout/slides.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
vuepress-theme-hope allows you to add slides pages.
\\n
You need to set layout: Slide in the frontmatter of the corresponding page to enable the slides page.
You should enable presentation feature in vuepress-plugin-md-enhance by setting plugins.mdEnhance.revealjs in theme options, otherwise the layout won't be rendered correctly.
-
-
-
No multiple slides
-
You should only include a single slide syntax on this page to avoid rendering problems.
-
@slidestart [your theme]
-
-// your slides
-
-@slideend
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.js
deleted file mode 100644
index 5237b07..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/chart/chartjs.html\",\"title\":\"Chart.js\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Chart.js\",\"icon\":\"chart-simple\",\"category\":[\"Markdown\"],\"tag\":[\"Chart\",\"Markdown\"],\"description\":\"File not found File not found\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/chart/chartjs.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/chart/chartjs.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/chart/chartjs.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Chart.js\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"File not found File not found\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Chart\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Chart.js\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.12,\"words\":36},\"filePathRelative\":\"guide/markdown/chart/chartjs.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.vue
deleted file mode 100644
index 9c14865..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/chart/chartjs.html.vue
+++ /dev/null
@@ -1,16 +0,0 @@
-
::: [type]-demo Optional title text
-
-```html
-<!-- ↑ use available ones -->
-<!-- your code here -->
-<!-- you can have multiple code block, but each language must appear only once. -->
-```
-
-```json
-// json block is for config
-{
- // your config here (optional)
-}
-```
-
-:::
-
-
Tips
-
The json block is optional, for config please see config.
You can use different language in your demo block.
-
When you set language which can not run on browsers, since the plugin is not able to resolve them, so demo display will be disabled. The plugin will only show the code and provide you a button to open it in CodePen.
-
Available HTML languages:
-
-
"html" (default)
-
"slim"
-
"haml"
-
"markdown"
-
-
-
You can also use md in code block.
-
-
Available JS languages:
-
-
"javascript" (default)
-
"coffeescript"
-
"babel"
-
"livescript"
-
"typescript"
-
-
-
You can also use js, ts, coffee and ls in code block.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.js
deleted file mode 100644
index a596b96..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/code/\",\"title\":\"Code\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Code\",\"icon\":\"laptop-code\",\"dir\":{\"collapsible\":false,\"order\":5,\"link\":true},\"category\":[\"Markdown\"],\"tag\":[\"Code\",\"Markdown\"],\"description\":\"This plugin provides the following features to enhance coding: Code Tabs: Add tabs to your code block. Code Demo: Display and run code snippets in browser. Playground: Embed ext...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/code/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/code/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/code/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Code\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This plugin provides the following features to enhance coding: Code Tabs: Add tabs to your code block. Code Demo: Display and run code snippets in browser. Playground: Embed ext...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Code\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Code\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[{\"level\":3,\"title\":\"Code Tabs\",\"slug\":\"code-tabs\",\"link\":\"#code-tabs\",\"children\":[]},{\"level\":3,\"title\":\"Code Demo\",\"slug\":\"code-demo\",\"link\":\"#code-demo\",\"children\":[]},{\"level\":3,\"title\":\"Playground\",\"slug\":\"playground\",\"link\":\"#playground\",\"children\":[]},{\"level\":3,\"title\":\"Kotlin Playground\",\"slug\":\"kotlin-playground\",\"link\":\"#kotlin-playground\",\"children\":[]},{\"level\":3,\"title\":\"Vue Playground\",\"slug\":\"vue-playground\",\"link\":\"#vue-playground\",\"children\":[]},{\"level\":3,\"title\":\"Sandpack\",\"slug\":\"sandpack\",\"link\":\"#sandpack\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.07,\"words\":20},\"filePathRelative\":\"guide/markdown/code/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.vue
deleted file mode 100644
index 3d8a644..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/index.html.vue
+++ /dev/null
@@ -1,73 +0,0 @@
-
-
This plugin provides the following features to enhance coding:
-
-
Code Tabs: Add tabs to your code block.
-
Code Demo: Display and run code snippets in browser.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/playground.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/playground.html.js
deleted file mode 100644
index bebaa3d..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/playground.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/code/playground.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/code/playground.html\",\"title\":\"Playground\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Playground\",\"icon\":\"code\",\"category\":[\"Markdown\"],\"tag\":[\"Markdown\",\"Playground\"],\"description\":\"Let the Markdown file support playground in your VuePress site.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/code/playground.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/code/playground.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/code/playground.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Playground\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Let the Markdown file support playground in your VuePress site.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Playground\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Playground\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Settings\",\"slug\":\"settings\",\"link\":\"#settings\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.52,\"words\":157},\"filePathRelative\":\"guide/markdown/code/playground.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Let the Markdown file support playground in your VuePress site.
Let the Markdown file support vue playground in your VuePress site.
-
-
-
Tips
-
Since we are providing a runtime compiler, we are introducing the whole @vue/compiler-sfc package with typescript support, so the whole Vue Playground chunk is > 4MB. So you should only use this if you are heavily depending on interactive Vue Playground.
-
You can use Vue Demo and Playground Vue Preset as an alternative.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/footnote.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/footnote.html.js
deleted file mode 100644
index 6b75526..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/footnote.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/footnote.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/content/footnote.html\",\"title\":\"Footnote\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Footnote\",\"icon\":\"quote-left\",\"category\":[\"Markdown\"],\"tag\":[\"Footnote\",\"Markdown\"],\"description\":\"Let the Markdown file in your VuePress site support footnotes.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/content/footnote.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/content/footnote.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/content/footnote.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Footnote\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Let the Markdown file in your VuePress site support footnotes.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Footnote\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Footnote\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Settings\",\"slug\":\"settings\",\"link\":\"#settings\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.15,\"words\":44},\"filePathRelative\":\"guide/markdown/content/footnote.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Let the Markdown file in your VuePress site support footnotes.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/include.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/include.html.js
deleted file mode 100644
index 16a0ea9..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/include.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/include.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/content/include.html\",\"title\":\"Include Files\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Include Files\",\"icon\":\"fab fa-markdown\",\"category\":[\"Markdown\"],\"tag\":[\"Code Demo\",\"Include Files\"],\"description\":\"Let the Markdown file in your VuePress site support including other files.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/content/include.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/content/include.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/content/include.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Include Files\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Let the Markdown file in your VuePress site support including other files.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Code Demo\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Include Files\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Include Files\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Settings\",\"slug\":\"settings\",\"link\":\"#settings\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.73,\"words\":220},\"filePathRelative\":\"guide/markdown/content/include.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Let the Markdown file in your VuePress site support including other files.
Also, to place your Markdown files directly besides your actual files, but don't want them rendered as pages, you can set pagePatterns options in VuePress config. See pagePatterns for more details.
-
-TS
-JS
-
-
import { defineUserConfig } from "vuepress";
-import { hopeTheme } from "vuepress-theme-hope";
-
-export default defineUserConfig({
- // now any file with `.snippet.md` extension will not be rendered as a page
- pagePatterns: ["**/*.md", "!**/*.snippet.md", "!.vuepress", "!node_modules"],
-
- theme: hopeTheme({
- plugins: {
- mdEnhance: {
- include: true,
- },
- },
- }),
-});
-
-
-
import { hopeTheme } from "vuepress-theme-hope";
-
-export default {
- // now any file with `.snippet.md` extension will not be rendered as a page
- pagePatterns: ["**/*.md", "!**/*.snippet.md", "!.vuepress", "!node_modules"],
-
- theme: hopeTheme({
- plugins: {
- mdEnhance: {
- include: true,
- },
- },
- }),
-};
-
-
-
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.js
deleted file mode 100644
index 6ec4884..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/content/\",\"title\":\"Content\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Content\",\"icon\":\"pen\",\"dir\":{\"collapsible\":false,\"order\":2,\"link\":true},\"index\":false,\"category\":[\"Markdown\"],\"tag\":[\"Content\",\"Markdown\"],\"description\":\"This plugin provides the following ways to enrich your content. Component: quickly insert component in M. Footnotes: Supplementary explanation of key content Import files: Easil...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/content/\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/content/\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/content/\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Content\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"This plugin provides the following ways to enrich your content. Component: quickly insert component in M. Footnotes: Supplementary explanation of key content Import files: Easil...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Content\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Content\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[{\"level\":3,\"title\":\"component\",\"slug\":\"component\",\"link\":\"#component\",\"children\":[]},{\"level\":3,\"title\":\"Footnote\",\"slug\":\"footnote\",\"link\":\"#footnote\",\"children\":[]},{\"level\":3,\"title\":\"Include files\",\"slug\":\"include-files\",\"link\":\"#include-files\",\"children\":[]},{\"level\":3,\"title\":\"Presentation\",\"slug\":\"presentation\",\"link\":\"#presentation\",\"children\":[]},{\"level\":3,\"title\":\"Tabs\",\"slug\":\"tabs\",\"link\":\"#tabs\",\"children\":[]}]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.07,\"words\":21},\"filePathRelative\":\"guide/markdown/content/README.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.vue
deleted file mode 100644
index f4fad0e..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/index.html.vue
+++ /dev/null
@@ -1,59 +0,0 @@
-
-
This plugin provides the following ways to enrich your content.
-
-
Component: quickly insert component in M.
-
Footnotes: Supplementary explanation of key content
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.js
deleted file mode 100644
index 35103b0..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/content/revealjs.html\",\"title\":\"Presentation\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Presentation\",\"icon\":\"person-chalkboard\",\"category\":[\"Markdown\"],\"tag\":[\"Markdown\",\"Slides\"],\"description\":\"Add presentation in your VuePress site via Reveal.js. Settings Install Reveal.js in your project: Then enabling via: Plugins and themes revealJs also receives an object as optio...\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/content/revealjs.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/content/revealjs.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/content/revealjs.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Presentation\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Add presentation in your VuePress site via Reveal.js. Settings Install Reveal.js in your project: Then enabling via: Plugins and themes revealJs also receives an object as optio...\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Slides\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Presentation\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Settings\",\"slug\":\"settings\",\"link\":\"#settings\",\"children\":[]},{\"level\":2,\"title\":\"Plugins and themes\",\"slug\":\"plugins-and-themes\",\"link\":\"#plugins-and-themes\",\"children\":[]},{\"level\":2,\"title\":\"Syntax\",\"slug\":\"syntax\",\"link\":\"#syntax\",\"children\":[]},{\"level\":2,\"title\":\"Demo\",\"slug\":\"demo\",\"link\":\"#demo\",\"children\":[]},{\"level\":2,\"title\":\"Customize Reveal.js\",\"slug\":\"customize-reveal-js\",\"link\":\"#customize-reveal-js\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.38,\"words\":113},\"filePathRelative\":\"guide/markdown/content/revealjs.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"\",\"autoDesc\":true}")
-export { comp, data }
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.vue b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.vue
deleted file mode 100644
index ff91636..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/revealjs.html.vue
+++ /dev/null
@@ -1,142 +0,0 @@
-
Add presentation in your VuePress site via Reveal.js.
You can also import and call defineRevealJsConfig in client config file to customize reveal.js:
-
import { defineClientConfig } from "vuepress/client";
-import { defineRevealJsConfig } from "vuepress-plugin-md-enhance/client";
-
-defineRevealJsConfig({
- // reveal.js options here
-});
-
-export default defineClientConfig({
- // ...
-});
-
-
Note
-
Reveal.js also provides more plugins, you can add them via plugin option in defineRevealJsConfig. Built-in plugins you request at node side will be added automatically.
-
-
You can also set revealJs to pass options to reveal.js per page in frontmatter.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/tabs.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/tabs.html.js
deleted file mode 100644
index 4eed7cb..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/tabs.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/content/tabs.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/content/tabs.html\",\"title\":\"Tabs\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"Tabs\",\"icon\":\"table-columns\",\"category\":[\"Markdown\"],\"tag\":[\"Markdown\",\"Tabs\"],\"description\":\"Let the Markdown file in your VuePress site support tabs.\",\"head\":[[\"link\",{\"rel\":\"canonical\",\"href\":\"https://theme-hope.vuejs.press/guide/markdown/content/tabs.html\"}],[\"link\",{\"rel\":\"alternate\",\"hreflang\":\"zh-tw\",\"href\":\"https://vuepress-theme-hope.github.io/v2/zh/guide/markdown/content/tabs.html\"}],[\"meta\",{\"property\":\"og:url\",\"content\":\"https://vuepress-theme-hope.github.io/v2/guide/markdown/content/tabs.html\"}],[\"meta\",{\"property\":\"og:site_name\",\"content\":\"vuepress-theme-hope\"}],[\"meta\",{\"property\":\"og:title\",\"content\":\"Tabs\"}],[\"meta\",{\"property\":\"og:description\",\"content\":\"Let the Markdown file in your VuePress site support tabs.\"}],[\"meta\",{\"property\":\"og:type\",\"content\":\"article\"}],[\"meta\",{\"property\":\"og:locale\",\"content\":\"en-US\"}],[\"meta\",{\"property\":\"og:locale:alternate\",\"content\":\"zh-TW\"}],[\"meta\",{\"property\":\"og:updated_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"meta\",{\"property\":\"article:author\",\"content\":\"Mr.Hope\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Markdown\"}],[\"meta\",{\"property\":\"article:tag\",\"content\":\"Tabs\"}],[\"meta\",{\"property\":\"article:modified_time\",\"content\":\"2024-08-12T12:32:37.000Z\"}],[\"script\",{\"type\":\"application/ld+json\"},\"{\\\"@context\\\":\\\"https://schema.org\\\",\\\"@type\\\":\\\"Article\\\",\\\"headline\\\":\\\"Tabs\\\",\\\"image\\\":[\\\"\\\"],\\\"dateModified\\\":\\\"2024-08-12T12:32:37.000Z\\\",\\\"author\\\":[{\\\"@type\\\":\\\"Person\\\",\\\"name\\\":\\\"Mr.Hope\\\",\\\"url\\\":\\\"https://mister-hope.com\\\"}]}\"],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/atom+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/atom.xml\",\"title\":\"vuepress-theme-hope Atom Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/json\",\"href\":\"https://vuepress-theme-hope.github.io/v2/feed.json\",\"title\":\"vuepress-theme-hope JSON Feed\"}],[\"link\",{\"rel\":\"alternate\",\"type\":\"application/rss+xml\",\"href\":\"https://vuepress-theme-hope.github.io/v2/rss.xml\",\"title\":\"vuepress-theme-hope RSS Feed\"}]]},\"headers\":[{\"level\":2,\"title\":\"Settings\",\"slug\":\"settings\",\"link\":\"#settings\",\"children\":[]}],\"git\":{\"createdTime\":1723465957000,\"updatedTime\":1723465957000,\"contributors\":[{\"name\":\"sinotec2\",\"email\":\"sinotec2@gmail.com\",\"commits\":1}]},\"readingTime\":{\"minutes\":0.15,\"words\":44},\"filePathRelative\":\"guide/markdown/content/tabs.md\",\"localizedDate\":\"August 12, 2024\",\"excerpt\":\"
Let the Markdown file in your VuePress site support tabs.
-
-
diff --git a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/external.html.js b/docs/theme/src/.vuepress/.temp/pages/guide/markdown/external.html.js
deleted file mode 100644
index ed0aaa9..0000000
--- a/docs/theme/src/.vuepress/.temp/pages/guide/markdown/external.html.js
+++ /dev/null
@@ -1,3 +0,0 @@
-import comp from "/Users/kuang/GitHub/recipe/docs/theme/src/.vuepress/.temp/pages/guide/markdown/external.html.vue"
-const data = JSON.parse("{\"path\":\"/guide/markdown/external.html\",\"title\":\"External import\",\"lang\":\"en-US\",\"frontmatter\":{\"title\":\"External import\",\"icon\":\"link\",\"order\":-1,\"category\":[\"Markdown\"],\"tag\":[\"Markdown\"],\"description\":\"To using new syntax inside Markdown to enhance content, you can also use
- 
- 
-
