README.md

September 13, 2018 ยท View on GitHub

Currently not maintained! If you would like to resume maintenance, please open an issue!

core

officially supported awoo plugins

test status code coverage

core is the collective repository of officially supported plugins for the awoo static site generator. All of the packages here are safe and maintained.

Packages

PackageVersionDependenciesDescription
awoo-layoutsnpmDependency Statusreusable html templates
awoo-markdownnpmDependency Statusmarkdown parsing
awoo-matternpmDependency Statusfrontmatter parsing
awoo-metadatanpmDependency Statuscustom metadata
awoo-prettynpmDependency Statuspretty links

Development

To work on core, just clone the repository, install the npm dependencies, and bootstrap the lerna stuff. Like this:

git clone https://github.com/awoojs/core.git awoo-core
cd awoo-core
npm install
npx lerna bootstrap

If you're implementing a new plugin, you can pull inspiration from the other ones (making a plugin template is still on our TODO list, sadly). Just open a pull request and we'll help you out!

Team

Code of Conduct

This repository operates under the weallbehave Code of Conduct. Its contents can be found in CODE_OF_CONDUCT.md.

License

MIT