https://github.com/baofengs/vuepress-plugin-new
A terminal tool to create blog posts in vuepress
https://github.com/baofengs/vuepress-plugin-new
command-line vuepress vuepress-plugin vuepress-plugin-new
Last synced: 3 months ago
JSON representation
A terminal tool to create blog posts in vuepress
- Host: GitHub
- URL: https://github.com/baofengs/vuepress-plugin-new
- Owner: baofengs
- License: mit
- Created: 2019-07-03T03:50:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T21:11:28.000Z (over 2 years ago)
- Last Synced: 2024-04-25T02:25:47.359Z (about 1 year ago)
- Topics: command-line, vuepress, vuepress-plugin, vuepress-plugin-new
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/vuepress-plugin-new
- Size: 3.67 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vuepress-plugin-new
> This plugin requires VuePress >= **1.0.0**.
A vuepress command-line plugin to create markdown file just like `hexo new 'hello world'`
[中文说明](./zh/README.md)
## Features
- Auto create post markdown file in current directory
- Auto inject basic frontmatter config in post file
- Create post by default, use options `-d/--draft` to create a draft
- Auto fix file conflict
## Install
```bash
npm i vuepress-plugin-new
```
## Usage
### Using this plugin:
```js
// .vuepress/config.js
module.exports = {
plugins: [
'vuepress-plugin-export',
{
base: '_post'
}
]
}
```
### Then run:
New post named *hello vuepress*
```bash
vuepress new . 'hello vuepress'
```
New draft named *hello vuepress latter*
```bash
vuepress new . 'hello vuepress latter' -d/--draft
```
## Options
base
- Type: string
- Default: '.'
Provide the base path in the blog directory
## Development
```bash
git clone https://github.com/x-bao/vuepress-plugin-new
cd vuepress-plugin-new
yarn
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :P
## Author
**vuepress-plugin-new** © [San Baofeng](https://github.com/x-bao), Released under the [MIT](./LICENSE) License.
Authored and maintained by San Baofeng
> [San Baofeng's](https://arts.sanbaofengs.com) · GitHub [@San Baofeng](https://github.com/x-bao) · Twitter [@Baofeng15](https://twitter.com/Baofeng15)