Greenwood

Overview

Greenwood is a modern and performant static site generator supporting Web Component based development. For more information about how to get started, review our docs, or learn more about our project please visit our website.

Greenwood is currently a work in progress and we would love any help getting it to a 1.0 release. Check out our roadmap to see what we're working on next and feel free to reach out through our issue tracker if you have any issues or would like to request a feature!

Getting Started

Our website has a complete Getting Started section that will walk you through creating a Greenwood project from scratch.

You can follow along with, or clone and go, the companion repo.

Installation

Greenwood can be installed with your favorite JavaScript package manager.

# npm
npm -i @greenwood/cli --save-dev

# yarn
yarn add @greenwood/cli --dev

Then in your package.json, you can run the CLI like so:

"scripts": {
  "build": "greenwood build",
  "start": "greenwood develop"
}

• npm run build: generates a static build of your project
• npm start: starts a local development server for your project

Documentation

All of our documentation is on our website (which itself is built by Greenwood!). See our website documentation to learn more about:

• Configuration
• Pages
• Templates
• Component Model
• Styles and Assets

Contributing

We would love your contribution to Greenwood! Please check out our issue tracker for "good first issue" labels or feel to reach out to us on Gitter in the room "Greenwood" or on Twitter.

Built With Greenwood

Site	Repo	Project Details
The Greenhouse I/O	https://github.com/thegreenhouseio/www.thegreenhouse.io	Personal portfolio / blog website for @thescientist13 (Greenwood maintainer).

Built a site with Greenwood? Open a PR and add it here!

License

See the LICENSE file for license rights and limitations (MIT).