24 lines
564 B
Markdown
24 lines
564 B
Markdown
# PSI Data Catalog Documentation
|
|
|
|
This repository contains the source code for the [PSI Data Catalog
|
|
Documentation](https://data-catalog-services.pages.psi.ch/)
|
|
|
|
## Contributing
|
|
|
|
```console
|
|
docker compose up -d
|
|
```
|
|
|
|
to spin up a local environment. Preview available on `localhost:8000`.
|
|
|
|
## Style Guide
|
|
|
|
Pull requests enforce [markdownlint](https://github.com/DavidAnson/markdownlint) checks.
|
|
It is recommended to lint files before committing, either using your editor or by
|
|
running manually:
|
|
|
|
```console
|
|
npm install -g markdownlint-cli
|
|
npx markdownlint-cli .
|
|
```
|