Stig-Ørjan Smelror 8bfb51550a docs: update README.md with new structure and recent changes

- Modernize README with feature highlights and quick start guide
- Remove redundant information now in HOWTO.md
- Add sections for requirements, license, and contributing
- Document recent changes including i18n updates

2025-05-18 19:06:24 +02:00

1.7 KiB

Raw Blame History

Quick Site Generator 2

Quick Site Generator 2 is a powerful static website generator written in Zsh, inspired by Nikola. It's designed to be fast, flexible, and easy to use, with support for both custom QSTags and standard Markdown syntax.

Features

🚀 Blazing fast static site generation
📝 Supports both QSTags and Markdown content
🌍 Multi-language support (en_US, en_UK, es_ES, fr_FR, nb_NO)
🎨 Themeable with custom templates
📱 Responsive design ready
🔍 SEO friendly
🔄 Automatic rebuild on file changes

Quick Start

Installation

git clone https://github.com/kekePower/qsgen2.git
cd qsgen2
chmod +x qsgen2

Create a new site
```
./qsgen2 new my-site
cd my-site
```
Build and serve
```
./qsgen2 build
./qsgen2 serve
```

For detailed documentation, see the HOWTO.md guide.

Recent Changes

Added Norwegian (nb_NO) language support
Improved internationalization (i18n) system
Cleaned up temporary and backup files
Updated documentation
Added comprehensive HOWTO guide

Requirements

Zsh 5.8 or later
Pandoc (for Markdown support)
Basic Unix tools (sed, grep, etc.)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please read our contributing guidelines before submitting pull requests.

Support

For support, please open an issue on GitHub.

Created with ❤️ by kekePower

1.7 KiB Raw Blame History