https://github.com/renddslow/mcgregor
https://github.com/renddslow/mcgregor
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/renddslow/mcgregor
- Owner: Renddslow
- Created: 2021-08-24T14:20:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-12T19:10:16.000Z (over 3 years ago)
- Last Synced: 2025-02-23T17:18:25.701Z (4 months ago)
- Language: TypeScript
- Size: 619 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
McGregor
> 🧑🌾 A helpful digital gardening assistant for managing digital gardens in Hugo.
## Install
```
$ yarn add mcgregor
```
## Usage
```shell
Description
A helpful digital gardening assistant for managing digital gardens in Hugo.
Usage
$ mcgregor [options]
Available Commands
tend Mark who last tended a post.
For more info, run any command with the `--help` flag
$ mcgregor plant --help
$ mcgregor tend --help
Options
-v, --version Displays current version
-h, --help Displays this message
```
### `tend`
Mark who last tended a post.
Applies the `lastTended` hash to the frontmatter of a post which includes the current date and who made the modification according to the git config of the changing user.
The resulting frontmatter will look like:
```markdown
---
lastTended:
by: Luke Skywalker
when: 2021-08-31
---
```
Files should be passed to the `tend` script after all options have been passed:
```shell
$ mcgregor tend example.md packages/core/CHANGELOG.md
```
## API