Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

antoinezanardi
Copy link
Contributor

πŸ”— Linked issue

[Ø]

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

A modest improvement to the main README file by adding :

  • Table of contents with anchors to go to sections.
  • Icons in header sections.
  • Block quotes for tips.
  • Added scoped attribute to <style> in example.

A readable and colorful README is always a great way to welcome new potential Nuxt users πŸ”οΈ.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@antoinezanardi antoinezanardi changed the title docs(readme): improve readme readability with table of contents, anch… docs: improve readme readability with table of contents, anch… Mar 6, 2024
@antoinezanardi antoinezanardi changed the title docs: improve readme readability with table of contents, anch… docs: improve readme readability Mar 6, 2024
@atinux
Copy link
Member

atinux commented Mar 6, 2024

I love it! Merci @antoinezanardi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants