From c69806006ce0ebd41e5dc6876db2895ce3745f69 Mon Sep 17 00:00:00 2001 From: Rex P <106129829+another-rex@users.noreply.github.com> Date: Thu, 28 Dec 2023 11:28:00 +1100 Subject: [PATCH] Add formatting instructions to docs contribution (#723) I just realized that our contributing to docs instructions is circular (CONTRIBUTING.md points to docs/README.md which points back to CONTRIBUTING.md). I removed that line and added in the formatting instructions. --------- Co-authored-by: Hayley Denbraver --- docs/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 89faf2c1daa..290b0e76cc9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,9 +11,19 @@ Here are other [pre-requisites] and instructions for running the [docs locally]. [pre-requisites]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#prerequisites [docs locally]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#building-your-site-locally -## Contributing to the docs +## Formatting docs -Please see [CONTRIBUTING.md](https://github.com/google/osv-scanner/blob/main/CONTRIBUTING.md/#contributing-documentation) for information on contributing documentation. +We use - [Prettier](https://prettier.io/) to standardize the format of markdown and config files. + +This requires [node/npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to be installed. + +### Running the formatter + +Run the following in the project directory: + +```shell +./scripts/run_formatters.sh +``` ## Documentation theme