Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ Or for markdown:

```md
![image_description](/img/path/to/image.png)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite?ref=badge_shield)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The FOSSA status badge has been added to an example code block for how to include images in Markdown. This is likely to be confusing for contributors, as it's not part of the standard syntax for images and doesn't belong in a generic example. The badge is more appropriately placed only in the new "License" section.

```

Docusaurus automatically handles image optimization including:
Expand All @@ -143,3 +144,7 @@ Docusaurus automatically handles image optimization including:
Please follow this standard when contributing images to the documentation.

Happy contributing!


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite?ref=badge_large)
Comment on lines +147 to +150

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There are a couple of minor formatting issues here. There's an extra blank line before the ## License heading, and the file is missing a final newline character. It's good practice to have a single blank line separating sections and to end files with a newline for POSIX compatibility and to avoid issues with some tools.

Suggested change
## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite?ref=badge_large)
## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkmesh-net%2Fwebsite?ref=badge_large)