It's recommended to read the whole documentation!
- ✨ Features
- 🚧 Planned features and issues
- 📚 Getting started and full documentation
- 🎁 Support
- ©️ License
Static site generator / project skeleton for creating production-ready sites. All necessary files and build tasks are already in place and fitted with good practices. You only need to install the dependencies and your are ready to go, perfect for RESTful sites.
The goal of this generator is to have a project skeleton with everything already prepared to quickly start with a new project without being restricted by any limits like a template system of a specific CMS. You can easily add, remove or replace features like the Pug template engine if you don't want to use them.
Disclaimer: This project is not intended as a well maintained and stable open source project. It's for my own learning and experimentation with new technologies. Therefore I can't ensure that it can be used anytime and anywhere without issues. Still I'm looking for your feedback and opinions.
- Fast layouting with pre-compiling Pug templates
- Project structure based on the atomic design concept (you can easily change it if you don't want to use it)
- SASS as CSS preprocessor
- BEM as default naming syntax for CSS classes (you don't have to follow this)
- Automated build pipeline with Gulp 4
- Node.js® compability
- Latest release from the Current branch
- Latest release from the LTS branch
Checkout the issues page
If you are interesed how some things works or what is possible read the full documentation
"Donations are not required but always appreciated."
Like this quote implies, I won't stop make things open source, if there are no donations. But they would always be appreciated by me ❤
Copyright 2020 Simon Knittel (https://simonknittel.de)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.