readme.md

Build Plus

Generate Static HTML Pages from Single Page Applications 🚀

Build Plus is a powerful tool that allows you to effortlessly add static HTML pages into your Single Page Application (SPA) build, significantly enhancing SEO capabilities. 🌐✨

Seamless Integration

Integrating Build Plus into your build process is a breeze. Simply add the build-plus command to your existing build script, and you're good to go! 🎉

For instance, with create-react-app:

"scripts": {
  "build": "react-scripts build && build-plus"
}

Or with vite:

"scripts": {
  "build": "vite build && build-plus"
}

Compatibility

Build Plus seamlessly integrates with popular single page application frameworks including ReactJS, VueJS, Angular, and more.

👍 Great for static website hosting services.

Installation

npm install build-plus

Configuration file

Build Plus utilizes a pages.json configuration file by default, located at the root of your project. This file allows you to specify the paths you want to export as static pages.

Sample pages.json:

{
  "pages": [
    "/",
    "/home",
    "/about",
    "/contact",
    "/services",
    "/product/abc",
    "/product/def",
    "/product/ghi",
    "/product/jkl"
  ]
}

All coniguration parameters

Key	Usage
pages	List of paths which need to be exported
src	Build directory path (Default: build)
port	Port to use while generating pages (Default: 8080)
base	Base path, e.g. github pages uses repository name as base path

To use a different configuration file:

build-plus some-other-build-plus-config.json

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Developer

Developed & maintained by neilveil.