Skip to content

Commit

Permalink
Add formatting section to AsyncAPI Style Guide
Browse files Browse the repository at this point in the history
Fixes asyncapi#1694

Add a new `.md` file for the Formatting section of the AsyncAPI Style Guide.

* Create a new file `formatting.md` in the `asyncapi.com/docs/community/styleguide/` directory.
* Add a title "AsyncAPI Style Guide: Formatting" at the top of the file.
* Add a section for "Notes and Warning Blocks" with guidelines for formatting notes and warning blocks.
* Add a section for "Code Blocks" with guidelines for formatting code blocks.
* Add a section for "White Space" with guidelines for using white space in documentation.
  • Loading branch information
Recxsmacx committed Feb 20, 2025
1 parent bcb402b commit a31e508
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions asyncapi.com/docs/community/styleguide/formatting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# AsyncAPI Style Guide: Formatting

## Notes and Warning Blocks
- Use blockquotes for notes and warnings.
- Use a consistent style for notes and warnings throughout the documentation.
- Example:
> **Note:** This is a note.
> **Warning:** This is a warning.
## Code Blocks
- Use triple backticks for code blocks.
- Specify the language for syntax highlighting.
- Example:
```javascript
console.log('Hello, world!');
```

## White Space
- Use white space to improve readability.
- Use blank lines to separate sections and paragraphs.
- Use indentation to indicate hierarchy and structure.

0 comments on commit a31e508

Please sign in to comment.