Skip to content

Rocky Docs Formatting - Add comment syntax #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2022
Merged

Rocky Docs Formatting - Add comment syntax #694

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions docs/guides/contribute/rockydocs_formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,19 @@ You can even embed a table or block quote (quite literally any formatting item t
3. There are more examples, but I think you get that everything can be nested within. Just remember the four (4) magic spaces.
```

## One Final Item - Comments

From time to time you may want to add a comment to your markdown that will not display when rendered. There are a lot of reasons why you might want to do this. For instance, if you want to add a placeholder for something that will be added later, you could use a comment to mark your spot.

The best way to add a comment to your markdown is to use the square brackets "[]" with two forward slashes "//" followed by a colon and the content. This would look like this:

```

[//]: This is a comment to be replaced later

```
A comment should have a blank line before and after the comment.

## More Reading

* The Rocky Linux [how to contribute document](README.md)
Expand Down