Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dword-design/nuxt-content-git

Additional module for @nuxt/content that replaces or adds createdAt and updatedAt dates based on the git history.
https://github.com/dword-design/nuxt-content-git

frontend javascript node nodejs npm npm-package nuxt nuxt-content nuxt-module nuxtjs nuxtjs-module webdevelopment

Last synced: 3 months ago
JSON representation

Additional module for @nuxt/content that replaces or adds createdAt and updatedAt dates based on the git history.

Host: GitHub
URL: https://github.com/dword-design/nuxt-content-git
Owner: dword-design
License: other
Created: 2021-03-22T10:05:07.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-05-29T05:05:32.000Z (8 months ago)
Last Synced: 2024-05-29T17:57:06.137Z (8 months ago)
Topics: frontend, javascript, node, nodejs, npm, npm-package, nuxt, nuxt-content, nuxt-module, nuxtjs, nuxtjs-module, webdevelopment
Language: JavaScript
Homepage:
Size: 1.68 MB
Stars: 21
Watchers: 3
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

# nuxt-content-git

Additional module for @nuxt/content that replaces or adds createdAt and updatedAt dates based on the git history.

## Install

```bash
# npm
$ npx nuxi module add nuxt-content-git

# Yarn
$ yarn nuxi module add nuxt-content-git
```

## Usage

Add the module to your `nuxt.config.js`:

```js
export default {
modules: [
'@nuxt/content',
'nuxt-content-git',
},
}
```

This will set `doc.createdAt` and `doc.updatedAt` with the dates from the Git log.

It is also possible to not override the values but instead specify the field names like this:

```js
export default {
modules: [
'@nuxt/content',
['nuxt-content-git', {
createdAtName: 'gitCreatedAt',
updatedAtName: 'gitUpdatedAt',
}],
],
}
```

Then you can access them via `doc.gitCreatedAt` and `doc.gitUpdatedAt`.

## Nuxt 2

For Nuxt 2 you need to add the module _before_ `@nuxt/content`:

```js
export default {
modules: [
'nuxt-content-git',
'@nuxt/content',
},
}
```

## Deployment

The module uses the Git history to calculate the dates. That is why the history also needs to be checked out when deploying the project to live. During local development the repository is usually deeply cloned. But CI systems like GitHub Actions often only do a shallow clone for performance reasons, which will result in wrong dates.

To do a deep clone in a GitHub Actions workflow, configure the checkout step the following way:

```yaml
- uses: actions/checkout
with:
fetch-depth: 0
```

Keep in mind that when deploying to static site hosters like GitHub Pages, you also need to do a deep clone on the system where you are generating the site. So do a local regular clone when generating locally, or use the config above for GitHub actions.

## Contribute

Are you missing something or want to contribute? Feel free to file an [issue](https://github.com/dword-design/nuxt-content-git/issues) or a [pull request](https://github.com/dword-design/nuxt-content-git/pulls)! ⚙️

## Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

If you want to send me a one time donation. The coffee is pretty good 😊.

Also for one time donations if you like PayPal.

Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

## See also

* [nuxt-content-body-html](https://github.com/dword-design/nuxt-content-body-html): Embed a Mermaid diagram in a Nuxt.js app by providing its diagram string.
* [nuxt-mail](https://github.com/dword-design/nuxt-mail): Adds email sending capability to a Nuxt.js app. Adds a server route, an injected variable, and uses nodemailer to send emails.
* [nuxt-route-meta](https://github.com/dword-design/nuxt-route-meta): Adds Nuxt page data to route meta at build time.
* [nuxt-modernizr](https://github.com/dword-design/nuxt-modernizr): Adds a Modernizr build to your Nuxt.js app.
* [nuxt-mermaid-string](https://github.com/dword-design/nuxt-mermaid-string): Embed a Mermaid diagram in a Nuxt.js app by providing its diagram string.

## License