Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 1.71 KB

README.md

File metadata and controls

65 lines (47 loc) · 1.71 KB
Raw

Grow.dev

PyPi [![GitHub Actions][github-image]][github-url] Downloads Code Coverage

Grow is a declarative tool for rapidly building, launching, and maintaining high-quality static HTML.

  • Easy installation
  • Jinja template engine
  • Content managed in YAML and JSON files
  • Data-binding between content and templates
  • Configuration-based site architecture
  • Easy URL changes
  • Flexible internationalization and translation
  • Integration with external CMSes
  • Integration with Google Sheets
  • Fast builds

Quick start

One time only: install Pipenv and libyaml.

# On Mac with Homebrew (https://brew.sh/).
brew install pipenv libyaml

# On Ubuntu.
sudo apt install -y pipenv libyaml-dev

# On other distributions.
sudo apt install python-pip; pip install pipenv

Next: install and run Grow using a starter.

git clone https://github.com/grow/starter
cd starter
pipenv install
pipenv run grow install
pipenv run grow run

Testing with pytest

You can test Grow using pytest which is compatible with the library Unittest. Install pytest and pytest-cov with

pip install pytest pytest-cov

then run

``bash pytest -svv --cov=grow


## Documentation

Visit https://grow.dev to read the documentation.

[github-image]: https://github.com/grow/grow/workflows/Test/badge.svg
[github-url]: https://github.com/grow/grow/actions