You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 13, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: docs/guide/getting-started.md
+35-17Lines changed: 35 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,18 @@
1
1
# Getting Started
2
2
3
+
::: tip
4
+
This section is a step-by-step tutorial with some concepts, and we recommend that you read it completely before using
5
+
this plugin.
6
+
:::
7
+
3
8
## Document Classifier
4
9
5
10
`Document classifier` is a set of functions that can classify pages with the same characteristics. For a blog developer, the same characteristics may exist between different pages as follows:
6
11
7
12
- Pages put in a directory (e.g. `_post`)
8
13
- Pages containing the same specific frontmatter key value (e.g. `tag: js`).
9
14
10
-
Of course, both of them may be related to another common
11
-
requirement, `pagination`.
15
+
Of course, both of them may be related to another common requirement, `pagination`.
12
16
13
17
So, how to combine them skillfully? Next, let's take a look at how this plugin solve these problems.
Actually, there are only 2 necessary layout components to create a blog theme:
315
+
## Writing a blog theme
316
+
317
+
If everything is ok, you can start to write a blog theme. Actually, there are only 2 necessary layout components to
318
+
create a blog theme:
305
319
306
320
- Layout
307
321
- Post
308
322
- Tag (Only required when you set up a `tag` frontmatter classification.)
309
323
310
-
Here is [live example](https://github.com/ulivz/70-lines-of-vuepress-blog-theme) that implements a functionally qualified VuePress theme in around 70 lines.
324
+
Here are two official examples (A simple & a complex) for you:
325
+
326
+
-[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.
327
+
-[@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog): Default blog theme for VuePress.
0 commit comments