https://github.com/semgrep/semgrep-docs
Documentation of Semgrep: a fast, open-source, static analysis tool.
https://github.com/semgrep/semgrep-docs
semgrep
Last synced: over 1 year ago
JSON representation
Documentation of Semgrep: a fast, open-source, static analysis tool.
- Host: GitHub
- URL: https://github.com/semgrep/semgrep-docs
- Owner: semgrep
- License: lgpl-2.1
- Created: 2020-10-26T16:16:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T19:00:21.000Z (over 1 year ago)
- Last Synced: 2025-04-02T19:26:08.713Z (over 1 year ago)
- Topics: semgrep
- Language: MDX
- Homepage: https://semgrep.dev/docs/
- Size: 107 MB
- Stars: 40
- Watchers: 22
- Forks: 83
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/adding-a-language.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: docs/security.md
- Support: docs/support.md
Awesome Lists containing this project
README
Lightweight static analysis for many languages.
Find bugs and enforce code standards.
This repository powers [Semgrep’s documentation](https://semgrep.dev/docs). Docs are built using [Docusaurus 3](https://docusaurus.io/).
## 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](https://github.com/semgrep/semgrep/blob/develop/CODE_OF_CONDUCT.md).
## 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 ``. This option is for contributors and writers.
2. Enter `yarn start` and then go to: ``. 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
```console
yarn build
```
This command generates static content into the `build` directory. Preview the production build by running:
```console
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](https://docusaurus.io/docs).
### Submitting PRs
Please submit suggested changes via PRs made against this repository’s `main` branch.