Skip to content
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.

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

docs: mention config file name before code block #19634

Merged
merged 1 commit into from Mar 13, 2023

Conversation

jofftiquez
Copy link
Contributor

Inspiration

I wasn't able to see the file name immediately in the code block example because it disappears whenever you're hovering in the code block which makes it confusing for beginners.

πŸ”— 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

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

**Inspiration**

I wasn't able to see the file name immediately in the code block example because it disappears whenever you're hovering in the code block which makes it confusing for beginners.
@codesandbox
Copy link

codesandbox bot commented Mar 13, 2023

CodeSandbox logoCodeSandbox logoΒ  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@danielroe danielroe changed the title refactor(docs): make config file explicit docs: mention config file name before code block Mar 13, 2023
@danielroe danielroe merged commit 31445c1 into nuxt:main Mar 13, 2023
@danielroe danielroe mentioned this pull request Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants