Skip to content

Commit

Permalink
添加 vuepress
Browse files Browse the repository at this point in the history
  • Loading branch information
itwanger committed Mar 14, 2022
1 parent 70c9713 commit dddf741
Show file tree
Hide file tree
Showing 33 changed files with 15,902 additions and 9 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.cache
.temp
26 changes: 26 additions & 0 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { defineHopeConfig } from "vuepress-theme-hope";
import themeConfig from "./themeConfig";

export default defineHopeConfig({
base: "/",

dest: "./dist",

head: [
[
"link",
{
rel: "stylesheet",
href: "//at.alicdn.com/t/font_2410206_mfj6e1vbwo.css",
},
],
],

locales: {
"/": {
lang: "zh-CN",
},
},

themeConfig,
});
52 changes: 52 additions & 0 deletions docs/.vuepress/navbar.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { defineNavbarConfig } from "vuepress-theme-hope";

export default defineNavbarConfig([
"/",
"/home",
{ text: "使用指南", icon: "creative", link: "/guide/" },
{
text: "博文",
icon: "edit",
prefix: "/posts/",
children: [
{
text: "文章 1-4",
icon: "edit",
prefix: "article/",
children: [
{ text: "文章 1", icon: "edit", link: "article1" },
{ text: "文章 2", icon: "edit", link: "article2" },
"article3",
"article4",
],
},
{
text: "文章 5-12",
icon: "edit",
children: [
{
text: "文章 5",
icon: "edit",
link: "article/article5",
},
{
text: "文章 6",
icon: "edit",
link: "article/article6",
},
"article/article7",
"article/article8",
],
},
{ text: "文章 9", icon: "edit", link: "article9" },
{ text: "文章 10", icon: "edit", link: "article10" },
"article11",
"article12",
],
},
{
text: "主题文档",
icon: "note",
link: "https://vuepress-theme-hope.github.io/v2/zh/",
},
]);
Binary file added docs/.vuepress/public/favicon.ico
Binary file not shown.
Binary file added docs/.vuepress/public/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { defineSidebarConfig } from "vuepress-theme-hope";

export default defineSidebarConfig([
"",
"home",
"slide",
{
text: "如何使用",
icon: "creative",
prefix: "guide/",
link: "guide/",
children: "structure",
},
{
text: "文章",
icon: "note",
prefix: "posts/",
children: [
{
text: "文章 1-4",
icon: "note",
collapsable: true,
prefix: "article/",
children: ["article1", "article2", "article3", "article4"],
},
{
text: "文章 5-12",
icon: "note",
children: [
{
text: "文章 5-8",
icon: "note",
collapsable: true,
prefix: "article/",
children: ["article5", "article6", "article7", "article8"],
},
{
text: "文章 9-12",
icon: "note",
children: ["article9", "article10", "article11", "article12"],
},
],
},
],
},
]);
Empty file.
Empty file.
96 changes: 96 additions & 0 deletions docs/.vuepress/themeConfig.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import { defineThemeConfig } from "vuepress-theme-hope";
import navbar from "./navbar";
import sidebar from "./sidebar";

export default defineThemeConfig({
hostname: "https://vuepress-theme-hope-v2-demo.mrhope.site",

author: {
name: "Mr.Hope",
url: "https://mrhope.site",
},

iconPrefix: "iconfont icon-",

logo: "/logo.svg",

repo: "https://github.com/vuepress-theme-hope/vuepress-theme-hope",

docsDir: "demo/src",

// navbar
navbar: navbar,

// sidebar
sidebar: sidebar,

footer: "默认页脚",

displayFooter: true,

pageInfo: ["Author", "Original", "Date", "Category", "Tag", "ReadingTime"],

blog: {
description: "一个前端开发者",
intro: "/intro.html",
medias: {
Baidu: "https://example.com",
Bitbucket: "https://example.com",
Dingding: "https://example.com",
Discord: "https://example.com",
Dribbble: "https://example.com",
Email: "https://example.com",
Evernote: "https://example.com",
Facebook: "https://example.com",
Flipboard: "https://example.com",
Gitee: "https://example.com",
GitHub: "https://example.com",
Gitlab: "https://example.com",
Gmail: "https://example.com",
Instagram: "https://example.com",
Lines: "https://example.com",
Linkedin: "https://example.com",
Pinterest: "https://example.com",
Pocket: "https://example.com",
QQ: "https://example.com",
Qzone: "https://example.com",
Reddit: "https://example.com",
Rss: "https://example.com",
Steam: "https://example.com",
Twitter: "https://example.com",
Wechat: "https://example.com",
Weibo: "https://example.com",
Whatsapp: "https://example.com",
Youtube: "https://example.com",
Zhihu: "https://example.com",
},
},

encrypt: {
config: {
"/guide/encrypt.html": ["1234"],
},
},

plugins: {
blog: {
autoExcerpt: true,
},

// 你也可以使用 Waline
comment: {
type: "giscus",
repo: "vuepress-theme-hope/giscus-discussions",
repoId: "R_kgDOG_Pt2A",
category: "Announcements",
categoryId: "DIC_kwDOG_Pt2M4COD69",
},

mdEnhance: {
enableAll: true,
presentation: {
plugins: ["highlight", "math", "search", "notes", "zoom"],
},
},
},
});
48 changes: 48 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
home: true
layout: Blog
icon: home
title: 博客主页
heroImage: /logo.svg
heroText: 你博客的名称
heroFullScreen: true
tagline: 你可以在这里放置你的口号与标语
projects:
- icon: project
name: 项目名称
desc: 项目详细描述
link: https://你的项目链接

- icon: link
name: 链接名称
desc: 链接详细描述
link: https://链接地址

- icon: book
name: 书籍名称
desc: 书籍详细描述
link: https://你的书籍链接

- icon: article
name: 文章名称
desc: 文章详细描述
link: https://你的文章链接

- icon: friend
name: 伙伴名称
desc: 伙伴详细介绍
link: https://你的伙伴链接

- icon: /logo.svg
name: 自定义项目
desc: 自定义详细介绍
link: https://你的自定义链接

footer: 自定义你的页脚文字
---

这是一个博客主页。

要使用此布局,你应该在页面前端设置 `layout: Blog``home: true`

相关配置文档请见 [博客主页](https://vuepress-theme-hope.github.io/v2/zh/guide/blog/home/)
9 changes: 0 additions & 9 deletions docs/bottom.md

This file was deleted.

16 changes: 16 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
index: false
icon: creative
category:
- 使用指南
---

# 主要功能与配置演示

- [页面展示](page.md)

- [Markdown 展示](markdown.md)

- [禁用展示](disable.md)

- [加密展示](encrypt.md)
42 changes: 42 additions & 0 deletions docs/guide/disable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
index: 3
title: 组件禁用
icon: config
category:
- 使用指南
tag:
- 禁用

navbar: false
sidebar: false

breadcrumb: false
pageInfo: false
contributors: false
editLink: false
lastUpdated: false
prev: false
next: false
comment: false
footer: false

backtotop: false
---

你可以通过设置页面的 Frontmatter,在页面禁用一些功能。

<!-- more -->

本页面应当禁用了:

- 导航栏
- 侧边栏
- 路径导航
- 页面信息
- 贡献者
- 编辑此页链接
- 更新时间
- 上一篇/下一篇 链接
- 评论
- 页脚
- 返回顶部按钮
15 changes: 15 additions & 0 deletions docs/guide/encrypt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
icon: lock
category:
- 使用指南
tag:
- 文章加密
---

# 密码加密的文章

实际的文章内容。

段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字。

段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字。
Loading

0 comments on commit dddf741

Please sign in to comment.