Skip to content

Commit

Permalink
docs: remove need to prepend local YAML schema
Browse files Browse the repository at this point in the history
  • Loading branch information
pandatix committed Dec 28, 2024
1 parent cd1a110 commit 268437f
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,17 @@ steps:

## Schema

For ease of use, you can generate and use the `ctfd-setup` YAML schema using `ctfd-setup schema`.
For ease of use, you can generate and use the YAML schema using `ctfd-setup schema`.

In your `.ctfd.yaml` file you could then prepend `# yaml-language-server: $schema=file:///path/to/schema.json`.
**(Optional)** In your `.ctfd.yaml` file you could then prepend `# yaml-language-server: $schema=file:///path/to/schema.json`.

<div align="center">
<img src="res/schema.png">
</div>

> [!NOTE]
> This will appear by default if your IDE has a YAML extension with support of the [JSON SchemaStore](https://www.schemastore.org/json/).

## Security

### Signature and Attestations
Expand Down

0 comments on commit 268437f

Please sign in to comment.