{"id":20777556,"url":"https://github.com/semgrep/semgrep-docs","last_synced_at":"2025-04-04T22:04:57.578Z","repository":{"id":37080731,"uuid":"307432427","full_name":"semgrep/semgrep-docs","owner":"semgrep","description":"Documentation of Semgrep: a fast, open-source, static analysis tool.","archived":false,"fork":false,"pushed_at":"2025-04-02T19:00:21.000Z","size":112264,"stargazers_count":40,"open_issues_count":17,"forks_count":83,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-04-02T19:26:08.713Z","etag":null,"topics":["semgrep"],"latest_commit_sha":null,"homepage":"https://semgrep.dev/docs/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/semgrep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/adding-a-language.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security.md","support":"docs/support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-26T16:16:58.000Z","updated_at":"2025-04-02T18:45:06.000Z","dependencies_parsed_at":"2025-04-02T19:34:18.783Z","dependency_job_id":null,"html_url":"https://github.com/semgrep/semgrep-docs","commit_stats":null,"previous_names":["semgrep/semgrep-docs","returntocorp/semgrep-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semgrep%2Fsemgrep-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semgrep%2Fsemgrep-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semgrep%2Fsemgrep-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semgrep%2Fsemgrep-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/semgrep","download_url":"https://codeload.github.com/semgrep/semgrep-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256110,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["semgrep"],"created_at":"2024-11-17T13:16:02.067Z","updated_at":"2025-04-04T22:04:57.553Z","avatar_url":"https://github.com/semgrep.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://semgrep.dev\"\u003e\u003cimg src=\"static/img/semgrep.svg\" height=\"130\" alt=\"Semgrep logo\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003ch3 align=\"center\"\u003e\n  Lightweight static analysis for many languages.\n  \u003c/br\u003e\n  Find bugs and enforce code standards.\n\u003c/h3\u003e\n\u003cbr /\u003e\n\nThis repository powers [Semgrep’s documentation](https://semgrep.dev/docs). Docs are built using [Docusaurus 3](https://docusaurus.io/).\n\n## Contributing\n\nContributions 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).\n\n## Building docs locally\n\n1. Clone the repository.\n2. Install: `yarn install`.\n3. On a clean git state, enter `yarn build`.\n4. 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.\n5. There are two options to run the docs locally:\n    1. Enter `yarn dev` and then go to `\u003chttp://localhost:3000/\u003e`. This option is for contributors and writers.\n    2. Enter `yarn start` and then go to: `\u003chttp://localhost:3000/\u003e`. 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.\n\nCongratulations. You have set up your local repository for development.\n\n## Preview production build\n\n```console\nyarn build\n```\n\nThis command generates static content into the `build` directory. Preview the production build by running:\n\n```console\nyarn serve\n```\n\nNote: Production build allows you to test redirects. Manage redirects in `docusaurus.config.js`.\n\n## Creating content\n\nContent 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.\n\nRead more about [creating documentation using Docusaurus here](https://docusaurus.io/docs).\n\n### Submitting PRs\n\nPlease submit suggested changes via PRs made against this repository’s `main` branch.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemgrep%2Fsemgrep-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsemgrep%2Fsemgrep-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemgrep%2Fsemgrep-docs/lists"}