An open API service indexing awesome lists of open source software.

https://github.com/inspektor-gadget/website

Inspektor Gadget's website
https://github.com/inspektor-gadget/website

Last synced: 13 days ago
JSON representation

Inspektor Gadget's website

Awesome Lists containing this project

README

        

# Inspektor Gadget's website

## Requirements

Node (version >= 18.0), npm and python3.

## Documentation preview

To preview your edits to docs in the inspektor-gadget repo run

```bash
make docs
npm install docusaurus
npm run dev
```

This will link docs from the `../inspektor-gadget` folder.
To link docs from other location use `IG_DOCS` env variable

```bash
IG_DOCS=some/place/inspektor-gadget/docs npm run dev
```

## Adding a new blog post

Create a new markdown file in `docs/`.
Some frontmatter properties:

- `slug` by convention all blog post paths are /YYYY/MM/title
- `image` you can use image from /static/ folder or relative path

[All possible frontmatter propeties](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog#markdown-front-matter)

**IMPORTANT**
Please remember to include `` after the first paragraph.
This will mark what will be shown as the preview in the "Latest" section in the blog.

[Markdown features docs](https://docusaurus.io/docs/markdown-features)