https://github.com/longern/vuepress-plugin-hyblog
https://github.com/longern/vuepress-plugin-hyblog
blog markdown vuepress vuepress-plugin
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/longern/vuepress-plugin-hyblog
- Owner: longern
- License: mit
- Created: 2022-06-13T01:01:04.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T11:44:49.000Z (almost 3 years ago)
- Last Synced: 2025-03-08T19:35:40.614Z (3 months ago)
- Topics: blog, markdown, vuepress, vuepress-plugin
- Language: TypeScript
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VuePress Plugin HyBlog
An out-of-the-box VuePress 2 blog plugin.
## Features
* Pagination
* Katex support
* Smart excerpt
* Styled form inputs
## Quickstart
Create `package.json` in your project root directory as:
```json
{
"devDependencies": {
"vuepress-plugin-hyblog": "*"
},
"scripts": {
"dev": "vuepress dev",
"build": "vuepress build"
}
}
```
Create `.vuepress/config.ts`:
```ts
import { defineUserConfig } from "vuepress";
import { hyblogPlugin } from "vuepress-plugin-hyblog";
export default defineUserConfig({
title: "My Blog",
plugins: [
hyblogPlugin(),
],
});
```
Build your blog with command:
```sh
npm install
npm run build
```
That's it! Your blog is built in `.vuepress/dist` directory.