Some silly improvements (decoration) in README.md #5974
Conversation
WalkthroughThe pull request introduces comprehensive formatting improvements to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
README.md (4)
Line range hint
30-39: Consider restructuring the feature list for better visual hierarchy.While the bold emphasis on the introduction is good, the feature list could be improved by using consistent formatting.
Consider this structure for better readability:
-Simple YAML format for creating and customizing vulnerability templates. -Contributed by thousands of security professionals to tackle trending vulnerabilities. +- **Simple YAML format:** Create and customize vulnerability templates +- **Community-driven:** Contributed by thousands of security professionals🧰 Tools
🪛 LanguageTool
[grammar] ~30-~30: Did you mean “are” or “were”?
Context: ...white">
**Nuclei is a modern, high-performance vulnerabilit...(SENT_START_NNS_IS)
🪛 Markdownlint (0.37.0)
22-22: null
Images should have alternate text (alt text)(MD045, no-alt-text)
45-54: Table of Contents formatting is inconsistent.The mix of backticks and italics in the ToC makes it harder to scan. Consider using a single style for better consistency.
-- [**`Get Started`**](#get-started) - - [_`1. Nuclei CLI`_](#1-nuclei-cli) +- [**Get Started**](#get-started) + - [_1. Nuclei CLI_](#1-nuclei-cli)
74-78: Important notice formatting could be improved.The important notice uses a mix of markdown and HTML table syntax, which might not render correctly on all platforms.
Consider using standard markdown blockquotes:
-> [!Important] -> |**This project is in active development**. Expect breaking changes with releases. Review the release changelog before updating.| -> |:--------------------------------| -> | This project is primarily built to be used as a standalone CLI tool. **Running nuclei as a service may pose security risks.** It's recommended to use with caution and additional security measures. | +> ⚠️ **Important** +> +> This project is in active development. Expect breaking changes with releases. Review the release changelog before updating. +> +> This project is primarily built to be used as a standalone CLI tool. **Running nuclei as a service may pose security risks.** It's recommended to use with caution and additional security measures.🧰 Tools
🪛 Markdownlint (0.37.0)
75-75: null
Tables should be surrounded by blank lines(MD058, blanks-around-tables)
421-421: Fix hyphenation in compound adjective.The term "AI powered" should be hyphenated when used as a compound adjective.
-**Try it online with our free AI powered Nuclei Templates Editor by** +**Try it online with our free AI-powered Nuclei Templates Editor by**🧰 Tools
🪛 LanguageTool
[uncategorized] ~421-~421: When ‘AI-powered’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...process. Try it online with our free AI powered Nuclei Templates Editor by [**`clicki...(POWERED_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(14 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~30-~30: Did you mean “are” or “were”?
Context: ...white">
**Nuclei is a modern, high-performance vulnerabilit...
(SENT_START_NNS_IS)
[uncategorized] ~86-~86: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...sting workflows:_ - 50x faster scans - Large scale scanning with high accuracy - Integrati...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~421-~421: When ‘AI-powered’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...process. Try it online with our free AI powered Nuclei Templates Editor by [**`clicki...
(POWERED_HYPHEN)
[style] ~457-~457: Consider using a different adverb to strengthen your wording.
Context: ...rs it used to take. This shift requires a completely different approach to tackling trending...
(COMPLETELY_ENTIRELY)
[grammar] ~459-~459: Did you mean “are” or “were”?
Context: ...vulnerabilities on the internet. Nuclei is now used and contributed by Fortune 500...
(SENT_START_NNS_IS)
🪛 Markdownlint (0.37.0)
README.md
105-105: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
105-105: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
58-58: null
Link fragments should be valid
(MD051, link-fragments)
75-75: null
Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🔇 Additional comments (2)
README.md (2)
3-12: Language selector improvements enhance readability.The reorganization of language links using
<div>and backticks improves visual consistency and accessibility.
633-633: Excellent addition of contributor avatar.Adding the PR author's avatar to the contributors section is a nice touch that recognizes their contribution.
|
|
||
| <p align="center"> | ||
| <div align="center"> | ||
|
|
||
| <a href="https://www.youtube.com/watch?v=b5qMyQvL1ZA&list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-getting-started.png" width="350px"></a> <a href="https://www.youtube.com/watch?v=nFXygQdtjyw&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-write-your-first-template.png" width="350px"></a> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add alt text to images for accessibility.
Images are missing alt text, which is important for accessibility and SEO.
-<img src="/static/nuclei-getting-started.png" width="350px">
+<img src="/static/nuclei-getting-started.png" width="350px" alt="Nuclei Getting Started Guide Video Thumbnail">📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <a href="https://www.youtube.com/watch?v=b5qMyQvL1ZA&list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-getting-started.png" width="350px"></a> <a href="https://www.youtube.com/watch?v=nFXygQdtjyw&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-write-your-first-template.png" width="350px"></a> | |
| <a href="https://www.youtube.com/watch?v=b5qMyQvL1ZA&list=PLZRbR9aMzTTpItEdeNSulo8bYsvil80Rl&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-getting-started.png" width="350px" alt="Nuclei Getting Started Guide Video Thumbnail"></a> <a href="https://www.youtube.com/watch?v=nFXygQdtjyw&utm_source=github&utm_medium=web&utm_campaign=nuclei_readme" target="_blank"><img src="/static/nuclei-write-your-first-template.png" width="350px" alt="Write Your First Nuclei Template Video Thumbnail"></a> |
🧰 Tools
🪛 Markdownlint (0.37.0)
105-105: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
105-105: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
|
Thanks for your contribution @1hehaq ! :) |
Proposed changes
Checklist
Summary by CodeRabbit