An open API service indexing awesome lists of open source software.

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

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.