An open API service indexing awesome lists of open source software.

https://github.com/rcpch/digital-growth-charts-documentation

Documentation site for all parts of the RCPCH Digital Growth Charts Project
https://github.com/rcpch/digital-growth-charts-documentation

documentation growth rcpch-growth-charts

Last synced: 4 months ago
JSON representation

Documentation site for all parts of the RCPCH Digital Growth Charts Project

Awesome Lists containing this project

README

          

# RCPCH Digital Growth Charts Documentation

This repository contains the documentation for the RCPCH Digital Growth Charts Platform. The live documentation can be found at

Built with:

[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

## Getting Started

Prerequisites: [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/).

To get started developing locally, clone the repository and run:

```bash
s/up
```

This `s/` script will set up the Docker containers needed to build and serve the documentation site locally. Once running, the documentation site will be available at , which should open in a browser automatically for you.

All other documentation regarding developing the documentation site can be found in `docs/developer/writing-documentation.md` or at

## Issues

Issues can be raised here