27 lines
629 B
TypeScript
27 lines
629 B
TypeScript
import type { Plugin } from 'vuepress/core';
|
|
import type { GitPluginOptions } from './options.js';
|
|
/**
|
|
* Git plugin
|
|
*
|
|
* Git 插件
|
|
*
|
|
* @param [options={}] - Plugin options / 插件选项
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { gitPlugin } from '@vuepress/plugin-git'
|
|
*
|
|
* export default {
|
|
* plugins: [
|
|
* gitPlugin({
|
|
* createdTime: true,
|
|
* updatedTime: true,
|
|
* contributors: true,
|
|
* changelog: false
|
|
* })
|
|
* ]
|
|
* }
|
|
* ```
|
|
*/
|
|
export declare const gitPlugin: ({ createdTime, updatedTime, contributors, changelog, filter, transformContributors, locales, }?: GitPluginOptions) => Plugin;
|