BoltStatic

Overview

BoltStatic is a fast and reliable Node.js-based static site generator inspired by GoHugo. It leverages the power of modern JavaScript to provide an efficient and flexible platform for building static websites. Whether you're a developer, content creator, or hobbyist, BoltStatic offers the tools you need to create high-performance, SEO-friendly websites with ease.

Features

• Templating System: Utilize Handlebars for simple and reusable components.
• Markdown Support: Write content in Markdown with built-in parsing.
• Asset Management: Efficiently handle CSS, JavaScript, images, and other assets.
• Plugin System: Extend functionality with a flexible plugin architecture.
• Theming: Customize your site with simple HTML templates and themes.
• Performance Optimized: Built with speed and efficiency in mind.
• Internationalization (i18n): Support for multiple languages.
• SEO Plugins: Enhance your site's visibility with SEO optimization plugins.
• Live Reloading: Develop with a local server that supports live-reloading.
• Extensive Documentation: Comprehensive guides and tutorials to get you started.

Installation

Prerequisites

• Node.js: Ensure you have Node.js (v14 or later) installed. You can download it from Node.js Official Website.

Install BoltStatic Globally

npm install -g boltstatic

Create a New Project

boltstatic new my-website
cd my-website

Usage

Development Server

Start a local development server with live-reloading:

boltstatic serve

Access your site at http://localhost:3000

Building the Site

Generate the static files for production:

boltstatic build

The generated site will be available in the dist/ directory.

Creating New Content

New Page

boltstatic new page about

This command creates a new Markdown file in the content/pages/ directory.

New Post

boltstatic new post "My First Blog Post"

This command creates a new Markdown file in the content/posts/ directory.

Configuration

Customize your site by editing the config.yaml file in the root directory.

title: "My BoltStatic Site"
description: "A blazing fast static site generated by BoltStatic."
baseURL: "https://www.myboltstaticsite.com"
language: "en"
theme: "default"
plugins:
  - seo
  - sitemap

Theming

BoltStatic supports theming through simple HTML templates. To switch themes:

1. Add your theme to the themes/ directory.
2. Update the config.yaml file to use your new theme.

theme: "my-custom-theme"

Plugins

Extend BoltStatic's functionality with plugins. To install a plugin:

1. Install the plugin via npm.

   npm install boltstatic-plugin-seo

2. Add the plugin to your config.yaml.

   plugins:
     - seo

Developing Plugins

Refer to the Plugin Development Guide for detailed instructions on creating your own plugins.

Contribution

We welcome contributions! Please see our Contributing Guide for more details.

License

This project is licensed under the MIT License.

Support

If you encounter any issues or have questions, feel free to open an issue on GitHub or join our Discord community.

Acknowledgements

• Inspired by GoHugo
• Built with Node.js
• Utilizes Handlebars for templating