A React client for Calavera
MIT License
This is the client part of Calavera. It allows to create a nice website from a Git repository containing Markdown docs.
Be sure to have Docker installed on your machine the:
git clone https://github.com/dunglas/calavera-react-client
git clone https://github.com/api-platform/docs data-src
docker run -v $PWD/data-src:/in -v $PWD/src/static/data:/out dunglas/calavera /in /out
cd data-src && find . -not -name '*.md' -exec rsync -R {} ../src/static/data \; && cd -
docker-compose run web npm install
docker-compose up
Features can be enabled or disabled using environment variables. If you use Docker, you can set them directly in the docker-compose.yml
file.
You can define two environment variables to enable the “Edit on GitHub” link:
CALAVERA_GITHUB_DOCUMENTATION_REPOSITORY
: the path of the github repo (eg. api-platform/docs
), with no trailing slash.CALAVERA_GITHUB_DOCUMENTATION_BRANCH
: the branch of the repo to link to (default to master
)Create a CALAVERA_GOOGLE_ANALYTICS_ID
environment variable containing your Google Analytics ID (UA-XXXXXXXX-1
) and the
Google Analytics integration will be enabled.
Main authors: Kévin Dunglas and Rodrigue Villetard. Sponsored by Les-Tilleuls.coop.
Built using React Redux Universal Hot Example.