modules icon indicating copy to clipboard operation
modules copied to clipboard

[Module Listing Request]: `nuxt-github-pages`

Open aaronlippold opened this issue 9 months ago • 1 comments

Description

Fix trailing slash issues when deploying to GitHub Pages by automatically creating duplicate HTML files during generation. This module ensures that both /path and /path/ URLs work correctly on GitHub Pages, preventing 404 errors when users directly access nested routes or refresh the page.

The module requires zero configuration and works seamlessly with both regular Nuxt pages and Nuxt Content. It's lightweight with no runtime overhead and supports TypeScript.

Repository

https://github.com/mitre/nuxt-github-pages

npm

https://www.npmjs.com/package/nuxt-github-pages

Nuxt Compatibility

Nuxt 3

aaronlippold avatar Jun 02 '25 21:06 aaronlippold

🚀 Module Update: v1.4.1 Released

Hi Nuxt team!

The \ module has been significantly enhanced since the initial submission:

Latest Features (v1.4.1):

🔍 SEO Optimization

  • Automatic canonical URL injection to prevent duplicate content issues
  • Addresses the concern raised in nuxt/nuxt#15462
  • Configurable via \ and \ options

📊 Production Ready

  • 21 comprehensive tests with real build environments
  • Full TypeScript support with proper types
  • Zero runtime overhead - build-time only
  • ~7KB package size - minimal footprint

🛠️ Developer Experience

  • Automated CI/CD with GitHub Actions
  • Dependabot integration for security updates
  • Extensive documentation and examples
  • Active maintenance and quick issue resolution

Stats:

  • npm: https://www.npmjs.com/package/nuxt-github-pages
  • Version: 1.4.1
  • License: Apache-2.0
  • Weekly Downloads: Growing steadily
  • Test Coverage: All features tested

The module solves a real pain point for Nuxt users deploying to GitHub Pages and is now battle-tested in production environments.

Would love to get this listed to help more developers! Let me know if you need any additional information.

aaronlippold avatar Jun 03 '25 16:06 aaronlippold