Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vuepress/vuepress-plugin-git-log
💾 Integrates git logs into VuePress.
https://github.com/vuepress/vuepress-plugin-git-log
Last synced: 5 days ago
JSON representation
💾 Integrates git logs into VuePress.
- Host: GitHub
- URL: https://github.com/vuepress/vuepress-plugin-git-log
- Owner: vuepress
- License: mit
- Archived: true
- Created: 2019-03-19T07:54:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-08T04:00:12.000Z (about 4 years ago)
- Last Synced: 2024-09-26T11:48:14.640Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://vuepress.github.io/plugins/git-log
- Size: 3.91 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - vuepress/vuepress-plugin-git-log - 💾 Integrates git logs into VuePress. (others)
README
# [vuepress-plugin-git-log](https://vuepress.github.io/plugins/git-log.html)
[](https://www.npmjs.com/package/vuepress-plugin-git-log)
A [VuePress](https://vuepress.vuejs.org/) plugin that integrates git logs into your page.
## Usage
### Global Installation
```bash
npm install -g vuepress-plugin-git-log
# OR
yarn global add vuepress-plugin-git-log
```
### Local Installation
```bash
npm install vuepress-plugin-git-log
# OR
yarn add vuepress-plugin-git-log
```
### Add to `config.js`
```js
module.exports = {
plugins: [
['git-log', {
additionalArgs: '--no-merge',
onlyFirstAndLastCommit: true,
}],
]
}
```
or
```js
module.exports = {
plugins: {
'git-log': {
additionalProps: {
subject: '%s',
authorEmail: '%ae',
},
},
}
}
```
## API
This plugin will add a `git` property to `$page`, with the following properties:
### git.author
The author of the article, i.e. the author of the first commit.
### git.created
The time the article was created, i.e. the authoring time of the first commit.
### git.updated
The time the article was updated, i.e. the committing time of the last commit.
### git.commits
A list of all the commits in chronological order.
### git.contributors
A list of contributors to all users who have modified the article.
## Configurations
### formatTime
- **type:** `(timestamp: number, lang: string) => string`
- **default:** `(timestamp, lang) => new Date(timestamp).toLocaleString(lang)`
A function used to format Unix time.
### additionalProps
- **type:** `{ [prop: string]: string }`
- **default:** `{}`
An object that represents additional properties. Every key is a property name and value is the corresponding [placeholder](https://git-scm.com/docs/git-log#_pretty_formats).
### additionalArgs
- **type:** `string | string[]`
- **default:** `[]`
A list of additional parameters to pass in.
### extendGitLog
- **type:** `(git: object) => void`
- **default:** `undefined`
A function used to extend or modify the [`$page.git`](#api) object.
### onlyFirstAndLastCommit
- **type:** `boolean`
- **default:** `false`
Whether to search for only the first and last commit. Set this option to `true` for large-scale projects may optimize the initial startup performance. However, you will not be able to use `$page.git.commits` and `$page.git.contributors` as a cost.