Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: vuepress/vuepress-plugin-blog
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.5.2
Choose a base ref
...
head repository: vuepress/vuepress-plugin-blog
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref

Commits on Dec 15, 2019

  1. build: setup linter

    billyyyyy3320 committed Dec 15, 2019
    Copy the full SHA
    6aabec6 View commit details
  2. style: lint code

    billyyyyy3320 committed Dec 15, 2019
    Copy the full SHA
    e8c5c6b View commit details
  3. Copy the full SHA
    c6a0383 View commit details

Commits on Dec 21, 2019

  1. Copy the full SHA
    c6d3971 View commit details
  2. chore: update examples

    billyyyyy3320 committed Dec 21, 2019
    Copy the full SHA
    69fa262 View commit details
  3. docs: guide sitemap

    billyyyyy3320 committed Dec 21, 2019
    Copy the full SHA
    4373f16 View commit details
  4. feat: integrate mailchimp (#49)

    * feat: intergrate mailchimp plugin
    
    * docs: add newsletter
    billyyyyy3320 authored Dec 21, 2019
    Copy the full SHA
    f7dbd92 View commit details
  5. Copy the full SHA
    074a599 View commit details
  6. v1.6.0

    billyyyyy3320 committed Dec 21, 2019
    Copy the full SHA
    d1c9768 View commit details
  7. chore: changelog

    billyyyyy3320 committed Dec 21, 2019
    Copy the full SHA
    d95c935 View commit details

Commits on Dec 22, 2019

  1. Copy the full SHA
    c1fafd7 View commit details
  2. Copy the full SHA
    3825854 View commit details
  3. v1.6.1

    billyyyyy3320 committed Dec 22, 2019
    Copy the full SHA
    d3ec332 View commit details
  4. chore: changelog

    billyyyyy3320 committed Dec 22, 2019
    Copy the full SHA
    e63c026 View commit details

Commits on Dec 27, 2019

  1. feat: add client apis

    email client api instead of out-of-box component
    comment client api for customiztion
    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    fceda2f View commit details
  2. docs: update newsletter

    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    04a38f2 View commit details
  3. Copy the full SHA
    5e1a88e View commit details
  4. v1.7.0

    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    ece0699 View commit details
  5. docs: add client apis

    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    6772342 View commit details
  6. chore: changlelog

    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    f8316cd View commit details
  7. chore: format docs

    billyyyyy3320 committed Dec 27, 2019
    Copy the full SHA
    a5d367e View commit details

Commits on Jan 2, 2020

  1. feat: bump deps

    billyyyyy3320 committed Jan 2, 2020
    Copy the full SHA
    977b229 View commit details
  2. Copy the full SHA
    4940903 View commit details

Commits on Jan 5, 2020

  1. Copy the full SHA
    828e5bf View commit details
  2. Copy the full SHA
    10d8f65 View commit details

Commits on Jan 6, 2020

  1. Copy the full SHA
    876ca8d View commit details
  2. v1.7.1

    billyyyyy3320 committed Jan 6, 2020
    Copy the full SHA
    86d5fb1 View commit details
  3. chore: changelog

    billyyyyy3320 committed Jan 6, 2020
    Copy the full SHA
    92fae58 View commit details

Commits on Jan 9, 2020

  1. Copy the full SHA
    3fdc6a3 View commit details
  2. Copy the full SHA
    b6325cd View commit details
  3. style: format stylus

    billyyyyy3320 committed Jan 9, 2020
    Copy the full SHA
    8629042 View commit details

Commits on Jan 10, 2020

  1. Copy the full SHA
    c3d8065 View commit details
  2. chore: add zh example

    billyyyyy3320 committed Jan 10, 2020
    Copy the full SHA
    70d02c9 View commit details
  3. Copy the full SHA
    259c308 View commit details
  4. v1.8.0

    billyyyyy3320 committed Jan 10, 2020
    Copy the full SHA
    0030bb7 View commit details
  5. chore: changelog

    billyyyyy3320 committed Jan 10, 2020
    Copy the full SHA
    11999d6 View commit details
  6. docs: enable editLinks

    billyyyyy3320 committed Jan 10, 2020
    Copy the full SHA
    402dc3e View commit details

Commits on Jan 12, 2020

  1. fix: sort uncorrect when writing date in 2-digits (fix #56) (#57)

    * fix: sort uncorrect when writing date in 2-digits
    
    * docs: update sorter section
    billyyyyy3320 authored Jan 12, 2020
    Copy the full SHA
    c3acf01 View commit details
  2. v1.8.1

    billyyyyy3320 committed Jan 12, 2020
    Copy the full SHA
    7b44cda View commit details
  3. chore: changelog

    billyyyyy3320 committed Jan 12, 2020
    Copy the full SHA
    236a756 View commit details

Commits on Jan 16, 2020

  1. Copy the full SHA
    84393ce View commit details
  2. Copy the full SHA
    458caeb View commit details
  3. Copy the full SHA
    16d318d View commit details
  4. docs: add faq section

    billyyyyy3320 committed Jan 16, 2020
    Copy the full SHA
    209f6b9 View commit details
  5. v1.9.0

    billyyyyy3320 committed Jan 16, 2020
    Copy the full SHA
    04d6102 View commit details
  6. chore: changelog

    billyyyyy3320 committed Jan 16, 2020
    Copy the full SHA
    b2bbac7 View commit details
  7. Copy the full SHA
    f71fbea View commit details
  8. v1.9.1

    billyyyyy3320 committed Jan 16, 2020
    Copy the full SHA
    3c5d4ea View commit details
  9. chore: changelog

    billyyyyy3320 committed Jan 16, 2020
    Copy the full SHA
    1ec709c View commit details

Commits on Jan 18, 2020

  1. Copy the full SHA
    0098baf View commit details
Showing with 4,382 additions and 853 deletions.
  1. +59 −0 .eslintrc.js
  2. +5 −0 .prettierrc.js
  3. +109 −0 CHANGELOG.md
  4. +15 −11 README.md
  5. +48 −0 README.zh-CN.md
  6. +43 −6 docs/.vuepress/config.js
  7. BIN docs/.vuepress/public/Disqus.png
  8. BIN docs/.vuepress/public/Newsletter.png
  9. BIN docs/.vuepress/public/Vssue.png
  10. +42 −8 docs/client-api/README.md
  11. +48 −0 docs/components/README.md
  12. +47 −1 docs/config/README.md
  13. +23 −0 docs/faq/README.md
  14. +1 −1 docs/guide/README.md
  15. +145 −25 docs/guide/getting-started.md
  16. +32 −21 docs/pagination/README.md
  17. +38 −0 docs/zh/README.md
  18. +141 −0 docs/zh/client-api/README.md
  19. +110 −0 docs/zh/components/README.md
  20. +260 −0 docs/zh/config/README.md
  21. +23 −0 docs/zh/faq/README.md
  22. +14 −0 docs/zh/guide/README.md
  23. +500 −0 docs/zh/guide/getting-started.md
  24. +103 −0 docs/zh/pagination/README.md
  25. +0 −20 examples/directory-classifier/.vuepress/config.js
  26. +0 −11 examples/directory-classifier/.vuepress/theme/layouts/DirectoryPagination.vue
  27. +0 −12 examples/directory-classifier/.vuepress/theme/layouts/IndexPost.vue
  28. +0 −1 examples/directory-classifier/_posts/2018-4-4-intro-to-vuepress.md
  29. +0 −1 examples/directory-classifier/_posts/2019-6-8-intro-to-vuepress-next.md
  30. +0 −1 examples/directory-classifier/_posts/2019-6-8-vueconf.md
  31. +0 −3 examples/disqus/.vuepress/config.js
  32. +0 −20 examples/frontmatter-classifier/.vuepress/config.js
  33. +0 −11 examples/frontmatter-classifier/.vuepress/theme/layouts/FrontmatterClassifier.vue
  34. +0 −11 examples/frontmatter-classifier/.vuepress/theme/layouts/Tags.vue
  35. +0 −3 examples/frontmatter-classifier/a.md
  36. +0 −3 examples/frontmatter-classifier/b.md
  37. +0 −3 examples/frontmatter-classifier/c.md
  38. +31 −0 examples/newsletter/.vuepress/config.js
  39. +7 −0 examples/newsletter/.vuepress/theme/layouts/FrontmatterKey.vue
  40. +22 −0 examples/newsletter/.vuepress/theme/layouts/GlobalLayout.vue
  41. +24 −0 examples/newsletter/.vuepress/theme/layouts/Layout.vue
  42. +7 −0 examples/newsletter/.vuepress/theme/layouts/Post.vue
  43. +12 −0 examples/newsletter/_posts/2018-11-7-frontmatter-in-vuepress.md
  44. +11 −0 examples/newsletter/_posts/2019-2-26-markdown-slot.md
  45. +12 −0 examples/newsletter/_posts/2019-5-16-writing-a-vuepress-theme-4.md
  46. +9 −0 examples/newsletter/_posts/2019-8-15-why-I-like-git-rebase.md
  47. +9 −0 examples/newsletter/_posts/2019-9-8-dive-into-vuepress-with-plugin-apis.md
  48. +34 −0 examples/sitemap+feed/.vuepress/config.js
  49. +7 −0 examples/sitemap+feed/.vuepress/theme/layouts/FrontmatterKey.vue
  50. +22 −0 examples/sitemap+feed/.vuepress/theme/layouts/GlobalLayout.vue
  51. +24 −0 examples/sitemap+feed/.vuepress/theme/layouts/Layout.vue
  52. +3 −0 examples/sitemap+feed/.vuepress/theme/layouts/Post.vue
  53. +12 −0 examples/sitemap+feed/_posts/2018-11-7-frontmatter-in-vuepress.md
  54. +11 −0 examples/sitemap+feed/_posts/2019-2-26-markdown-slot.md
  55. +12 −0 examples/sitemap+feed/_posts/2019-5-16-writing-a-vuepress-theme-4.md
  56. +9 −0 examples/sitemap+feed/_posts/2019-8-15-why-I-like-git-rebase.md
  57. +9 −0 examples/sitemap+feed/_posts/2019-9-8-dive-into-vuepress-with-plugin-apis.md
  58. +0 −3 examples/vssue/.vuepress/config.js
  59. +64 −0 examples/zh/.vuepress/config.js
  60. +7 −0 examples/zh/.vuepress/theme/layouts/FrontmatterKey.vue
  61. +18 −0 examples/zh/.vuepress/theme/layouts/GlobalLayout.vue
  62. +20 −0 examples/zh/.vuepress/theme/layouts/Layout.vue
  63. +15 −0 examples/zh/.vuepress/theme/layouts/Post.vue
  64. +12 −0 examples/zh/_posts/2019-7-21-打造多檔案結構的json-server.md
  65. +12 −0 examples/zh/_posts/2019-8-15-為什麼我愛用git rebase.md
  66. +16 −0 examples/zh/_posts/2019-9-8-透過插件API來深入了解VuePress.md
  67. +12 −0 examples/zh/_posts/2020-1-1-創建npm package的注意事項.md
  68. +57 −52 package.json
  69. +40 −38 src/client/classification.ts
  70. +4 −4 src/client/components.ts
  71. +65 −79 src/client/components/Comment.vue
  72. +104 −137 src/client/components/Pagination.vue
  73. +27 −22 src/client/components/SimplePagination.vue
  74. +66 −51 src/client/pagination.ts
  75. +13 −0 src/client/services.ts
  76. +144 −43 src/node/handleOptions.ts
  77. +77 −87 src/node/index.ts
  78. +2 −2 src/node/interface/Classifier.ts
  79. +3 −3 src/node/interface/ExtraPages.ts
  80. +3 −2 src/node/interface/Frontmatter.ts
  81. +27 −2 src/node/interface/Options.ts
  82. +2 −2 src/node/interface/PageEnhancer.ts
  83. +26 −11 src/node/interface/Pagination.ts
  84. +4 −4 src/node/interface/VuePress.ts
  85. +60 −46 src/node/pagination.ts
  86. +81 −47 src/node/util.ts
  87. +2 −2 src/types/VuePress.d.ts
  88. +10 −8 src/types/index.d.ts
  89. +1,296 −35 yarn.lock
59 changes: 59 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
module.exports = {
root: true,

env: {
"browser": true,
"commonjs": true,
"es6": true,
"node": true
},

extends: [
'plugin:vue/recommended',
'plugin:prettier/recommended',
'prettier/@typescript-eslint',
"prettier/vue",
],

parserOptions: {
parser: 'babel-eslint' // Support dynamic import
},

rules: {
'no-undef': ['error'],

'vue/match-component-file-name': [
'error',
{
extensions: ['js', 'vue'],
shouldMatchCase: false
}
],

'vue/prop-name-casing': 0,

'vue/require-default-prop': 0
},

overrides: [
{
files: ['*.ts'],
extends: [
'plugin:@typescript-eslint/recommended'
],
parser: 'vue-eslint-parser',
parserOptions: {
parser: '@typescript-eslint/parser'
},
rules: {
'@typescript-eslint/ban-ts-ignore': 0,

'@typescript-eslint/explicit-function-return-type': 0,

'@typescript-eslint/no-explicit-any': 0,

'@typescript-eslint/no-use-before-define': ['error', { functions: false }]
}
},
]
}
5 changes: 5 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
singleQuote: true,
tabWidth: 2,
trailingComma: 'es5',
}
109 changes: 109 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,112 @@
## [1.9.4](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.9.3...v1.9.4) (2021-01-17)


### Bug Fixes

* error when requiring dayjs ([#94](https://github.com/ulivz/vuepress-plugin-blog/issues/94)) ([52aa5ed](https://github.com/ulivz/vuepress-plugin-blog/commit/52aa5edebde8190035bdc85cfe43ad3978e60ceb))



## [1.9.3](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.9.2...v1.9.3) (2020-11-01)


### Bug Fixes

* pagination filter is incorrect when frontmatter key is number ([4abe10c](https://github.com/ulivz/vuepress-plugin-blog/commit/4abe10c8faf519e9aa682aae00ea80e1b4ec4185))



## [1.9.2](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.9.1...v1.9.2) (2020-01-18)


### Bug Fixes

* feed doesn't work fine when useing non-default directory name ([0098baf](https://github.com/ulivz/vuepress-plugin-blog/commit/0098bafdfd7c058a93b570a248e50c0459973117))



## [1.9.1](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.9.0...v1.9.1) (2020-01-16)


### Bug Fixes

* missing client apis for feed ([f71fbea](https://github.com/ulivz/vuepress-plugin-blog/commit/f71fbea487ab88deecd32d7f8f532f20ae2c0271))



# [1.9.0](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.8.1...v1.9.0) (2020-01-16)


### Features

* integrate with feed ([#58](https://github.com/ulivz/vuepress-plugin-blog/issues/58)) ([16d318d](https://github.com/ulivz/vuepress-plugin-blog/commit/16d318dd07d87492fc1dde8782d308a29c8bf7a5))



## [1.8.1](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.8.0...v1.8.1) (2020-01-12)


### Bug Fixes

* sort uncorrect when writing date in 2-digits (fix [#56](https://github.com/ulivz/vuepress-plugin-blog/issues/56)) ([#57](https://github.com/ulivz/vuepress-plugin-blog/issues/57)) ([c3acf01](https://github.com/ulivz/vuepress-plugin-blog/commit/c3acf01156ae62fc459d61faa053ddd1dcb43d50))



# [1.8.0](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.7.1...v1.8.0) (2020-01-10)


### Bug Fixes

* default sorter doesn't work fine in Safari ([#54](https://github.com/ulivz/vuepress-plugin-blog/issues/54)) ([3fdc6a3](https://github.com/ulivz/vuepress-plugin-blog/commit/3fdc6a318e3e8b65ce21fe1b9b224e1295a0a061))


### Features

* support configuring pagination link text ([c3d8065](https://github.com/ulivz/vuepress-plugin-blog/commit/c3d8065f2fcbaaa0c72014eec990ef987d5392d4))
* support configuring title for directories and frontmatters (close [#52](https://github.com/ulivz/vuepress-plugin-blog/issues/52))([#55](https://github.com/ulivz/vuepress-plugin-blog/issues/55)) ([b6325cd](https://github.com/ulivz/vuepress-plugin-blog/commit/b6325cd06a8e66e4fb6939e82c23107f45c33742))



## [1.7.1](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.7.0...v1.7.1) (2020-01-06)


### Bug Fixes

* extend page data on wrong pages (fix [#32](https://github.com/ulivz/vuepress-plugin-blog/issues/32))([#53](https://github.com/ulivz/vuepress-plugin-blog/issues/53)) ([876ca8d](https://github.com/ulivz/vuepress-plugin-blog/commit/876ca8d723d6724a57e13addf66ab5d3e3bb585f))


### Features

* bump deps ([977b229](https://github.com/ulivz/vuepress-plugin-blog/commit/977b229aa8cc014828fd78c657fa66249798b1c2))



# [1.7.0](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.6.1...v1.7.0) (2019-12-27)


### Features

* add client apis ([fceda2f](https://github.com/ulivz/vuepress-plugin-blog/commit/fceda2f8735b4a84dfa15aebc3bf19d707c3f035))



## [1.6.1](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.6.0...v1.6.1) (2019-12-22)


### Features

* create out-of-box component <newsletter> ([3825854](https://github.com/ulivz/vuepress-plugin-blog/commit/38258540a1f02a6f374f78332495c8e7444101a4))



# [1.6.0](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.5.2...v1.6.0) (2019-12-21)

### Features

* integrate mailchimp ([#49](https://github.com/ulivz/vuepress-plugin-blog/issues/49)) ([f7dbd92](https://github.com/ulivz/vuepress-plugin-blog/commit/f7dbd92ad07d17146c18da2719d1c47965178cce))



## [1.5.2](https://github.com/ulivz/vuepress-plugin-blog/compare/v1.5.1...v1.5.2) (2019-12-07)


26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,21 +6,17 @@

> Official blog plugin for VuePress.
## Status: WIP

Most of the planned features in place but there may still be bugs. API may still change until we remove this status tip. Do not use in production yet unless you are adventurous.

## Features

- [**Classification**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#document-classifier):
- [**Classification**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#document-classifier):
Powerful classification system lets you quickly classify your posts.
- [**Pagination**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#pagination):
- [**Pagination**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#pagination):
Pagination runs through the entire plugin, and it has never been so simple.
- [**Client APIs**](https://vuepress-plugin-blog.ulivz.com/client-api/): Simple client APIs make it easier for you to write a blog theme.
- [**Client APIs**](https://vuepress-plugin-blog.billyyyyy3320.com/client-api/): Simple client APIs make it easier for you to write a blog theme.

## Install

We strongly recommend that you read the [Getting Started](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html) section before using this plugin.
We strongly recommend that you read the [Getting Started](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html) section before using this plugin.

```bash
yarn add -D @vuepress/plugin-blog
@@ -35,20 +31,28 @@ module.exports = {
}
```

Please head [documentation](https://vuepress-theme-blog.ulivz.com/) to see all available options.
Please head [documentation](https://vuepress-plugin-blog.billyyyyy3320.com/) to see all available options.


## Projects Using `@vuepress/plugin-blog`

- [70-lines-of-vuepress-blog-theme](https://github.com/ulivz/70-lines-of-vuepress-blog-theme): A VuePress Blog Theme implemented in around 70 lines.
- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog): Default blog theme for VuePress.
- [vuepress-theme-modern-blog](https://github.com/z3by/vuepress-theme-modern-blog): A modern theme for Vue press using [Element.UI design system](https://element.eleme.io/#/)
- [vuepress-theme-reco](https://github.com/vuepress-reco/vuepress-theme-reco) - A simple and beautiful vuepress blog theme
- [vuepress-theme-hope](https://github.com/Mister-Hope/vuepress-theme-hope/) - A powerful vuepress blog theme with tons of features.
- [vuepress-theme-yuchanns](https://github.com/yuchanns/vuepress-theme-yuchanns): A github style vuepress blog theme
- [vuepress-theme-ic](https://github.com/IKangXu/vuepress-theme-ic) :tada::tada::tada: A note-style vuepress blog theme with simple, clear and practical features for the purpose. The palest ink is better than the best memory.
- [vuepress-theme-blogue](https://github.com/ocavue/vuepress-theme-blogue) A minimalist blog theme with Material Design.

Feel free to add yours here...


## Author

**@vuepress/theme-blog** © [ULIVZ](https://github.com/ulivz), Released under the [MIT](./LICENSE) License.<br>
## LICENSE

**@vuepress/plugin-blog** © [ULIVZ](https://github.com/ulivz) & [Billyyyyy3320](https://github.com/billyyyyy3320), Released under the [MIT](./LICENSE) License.<br>

> [github.com/ulivz](https://github.com/ulivz) · GitHub [@ULIVZ](https://github.com/ulivz) · Twitter [@_ulivz](https://twitter.com/_ulivz)
> [github.com/billyyyyy3320](https://github.com/billyyyyy3320) · GitHub [@Billyyyyy3320](https://github.com/billyyyyy3320)
48 changes: 48 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# @vuepress/plugin-blog

> VuePress 的官方博客插件。
## 特性

- [**分类器**](https://vuepress-plugin-blog.ulivz.com/zh/guide/getting-started.html#文档分类器)
强大的分类系统可让你快速对帖子进行分类。
- [**分页**](https://vuepress-plugin-blog.ulivz.com/zh/guide/getting-started.html#分页)
分页贯穿整个插件,它从未如此简单。
- [**客户端 API**](https://vuepress-plugin-blog.ulivz.com/zh/client-api/):简单的客户端 API 使你可以更轻松地编写博客主题。

## 安装

我们强烈建议你在使用此插件之前阅读 [Getting Started](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html) 部分。

```bash
yarn add -D @vuepress/plugin-blog
# OR npm install -D @vuepress/plugin-blog
```

## 使用

```javascript
module.exports = {
plugins: ['@vuepress/blog']
};
```

请转到 [文档](https://vuepress-theme-blog.ulivz.com/zh/) 查看所有可用选项。

## 正在使用 `@vuepress/plugin-blog` 的项目

- [70-lines-of-vuepress-blog-theme](https://github.com/ulivz/70-lines-of-vuepress-blog-theme): 大约 70 行实现的 VuePress 博客主题。
- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog): VuePress 的默认博客主题。
- [vuepress-theme-modern-blog](https://github.com/z3by/vuepress-theme-modern-blog): 一个使用 [Element.UI 设计系统](https://element.eleme.io/#/) 的现代主题
- [vuepress-theme-reco](https://github.com/vuepress-reco/vuepress-theme-reco) - 一个简单美观的 vuepress 博客主题
- [vuepress-theme-yuchanns](https://github.com/yuchanns/vuepress-theme-yuchanns): 一个 Github 风格的 vuepress 博客主题
- [vuepress-theme-ic](https://github.com/IKangXu/vuepress-theme-ic) :tada::tada::tada: 笔记样式的vuepress博客主题,具有简单,清晰和实用的功能。最浅的墨水比最好的记忆好。
- [vuepress-theme-hope](https://vuepress-theme.mrhope.site/): :zap: 一个轻量的 vuepress 主题

随时在这里添加你的主题...

## 作者

**@vuepress/theme-blog** © [ULIVZ](https://github.com/ulivz), 在 [MIT](./LICENSE) 许可证下发布。<br>

> [github.com/ulivz](https://github.com/ulivz) · GitHub [@ULIVZ](https://github.com/ulivz) · Twitter [@\_ulivz](https://twitter.com/_ulivz)
49 changes: 43 additions & 6 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
module.exports = {
title: '@vuepress/plugin-blog',
description: 'Offical blog plugin for VuePress',
locales: {
'/': {
lang: 'en-US',
},
'/zh/': {
lang: 'zh-CN',
description: 'Vuepress 官方博客插件',
},
},
description: 'Official blog plugin for VuePress',
themeConfig: {
repo: 'ulivz/vuepress-plugin-blog',
repo: 'vuepressjs/vuepress-plugin-blog',
docsDir: 'docs',
editLinks: true,
editLinkText: 'Edit this page on GitHub',
nav: [
{ text: 'Guide', link: '/guide/' },
{ text: 'Config', link: '/config/' },
{ text: 'Pagination', link: '/pagination/' },
{ text: 'Client API', link: '/client-api/' },
{ text: 'Components', link: '/components/' },
{ text: 'FAQ', link: '/faq/' },
],
sidebarDepth: 3,
sidebar: {
@@ -17,13 +31,36 @@ module.exports = {
title: 'Guide',
collapsable: false,

children: [
'',
'getting-started',
],
children: ['', 'getting-started'],
},
],
},
locales: {
'/': {
label: 'English',
},
'/zh/': {
nav: [
{ text: '指南', link: '/zh/guide/' },
{ text: '配置', link: '/zh/config/' },
{ text: '分页', link: '/zh/pagination/' },
{ text: '客户端 API', link: '/zh/client-api/' },
{ text: '组件', link: '/zh/components/' },
{ text: 'FAQ', link: '/zh/faq/' },
],
sidebar: {
'/zh/guide/': [
{
title: '指南',
collapsable: false,
children: ['', 'getting-started'],
},
],
},
selectText: '选择语言',
label: '简体中文',
},
},
smoothScroll: true,
},
}

Binary file added docs/.vuepress/public/Disqus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/Newsletter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/Vssue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading