azu / semgrep-docs

Documentation of Semgrep: a fast, open-source, static analysis tool.

Lightweight static analysis for many languages.
Find bugs and enforce code standards.

This repository powers Semgrep’s documentation. Docs are built using Docusaurus 2.

Contributing

Contributions to the docs are welcome! To start contributing, first please make sure you read and agree with the Semgrep’s Contributor Covenant Code of Conduct.

Building docs locally

1. Clone the repo
2. Install: yarn install
3. Run locally: yarn start and then go to: <http://localhost:3000/>

Preview production build

yarn build

This command generates static content into the build directory. Preview the production build by running:

yarn serve

Creating content

Content is written in regular Markdown or MDX files. Markdown and MDX files optionally contain YAML style metadata (front matter) at the top of the file. You can use front matter to override attributes like the slug and other things.

Read more about creating documentation using Docusaurus here.

Submitting PRs

Please submit suggested changes via PRs made against this repository’s main branch.