semgrep-docs

semgrep-docs copied to clipboard

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 repository.
2. Install: yarn install.
3. On a clean git state, enter yarn build.
4. Enter git checkout . The previous command yarn build overwrites some placeholders with exact values and these should not be committed. In most cases, there is no need to run yarn build after this initial set up process.
5. There are two options to run the docs locally:
   1. Enter yarn dev and then go to <http://localhost:3000/>. This option is for contributors and writers.
   2. Enter yarn start and then go to: <http://localhost:3000/>. This option is for displaying an accurate preview of the live documentation. It runs a script that replaces certain identifiers with code or file templates. These replacements ensure that certain code or file templates are up-to-date.

Congratulations. You have set up your local repository for development.

Preview production build

yarn build

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

yarn serve

Note: Production build allows you to test redirects. Manage redirects in docusaurus.config.js.

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.