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: Improve language across multiple documentation files #710

Merged
merged 1 commit into from
Aug 6, 2023

Conversation

nicokempe
Copy link
Contributor

  • Enhanced clarity and readability of the content across 11 documentation files.
  • Corrected various grammar, syntax, and punctuation errors.
  • Improved phrasing and use of terminology where required.
  • Ensured consistency in language and style across the documents.
  • Optimized sentence structure for better understanding.

* Enhanced clarity and readability of the content across 11 documentation files.
* Corrected various grammar, syntax, and punctuation errors.
* Improved phrasing and use of terminology where required.
* Ensured consistency in language and style across the documents.
* Optimized sentence structure for better understanding.
@nuxt-studio
Copy link

nuxt-studio bot commented Aug 3, 2023

Live Preview ready!

Name Edit Preview Latest Commit
TailwindCSS Edit on Studio ↗︎ View Live Preview d1fd3b3

@what-the-diff
Copy link

what-the-diff bot commented Aug 3, 2023

PR Summary

  • Updated Documentation for docs/content/0.index.md
    Focusing more on highlighting the efficiency and easy setup with the Tailwind CSS in a Nuxt application. The module description now includes statistics on contributors and monthly downloads.

  • Clarified Details in docs/content/1.getting-started/1.setup.md
    The behavior of the module when there are missing required files and steps to add @tailwind directives to custom CSS file are now clearer.

  • Added Explanation to docs/content/1.getting-started/2.options.md
    The purpose of cssPath and exposeLevel options are now properly explained. Also updated information on how users can manipulate the position option.

  • Updated Configurations in docs/content/2.tailwind/1.config.md
    Instructions on how to set the Tailwind config through the nuxt.config file have been made clearer. New examples and updates to the mergingStrategy and safelist options have been included.

  • Amplified Details for docs/content/2.tailwind/2.viewer.md
    The viewer's availability starting from version v3.4.0 of @nuxtjs/tailwindcss is included in the description now.

  • Enhanced Support Info in docs/content/2.tailwind/3.editor-support.md
    The requirement for installing tailwindcss in the top-level node_modules has been clarified for pnpm users. Additionally, an example of configuring autocomplete based on tailwind.config has been provided.

  • Enriched Details for docs/content/3.examples/1.basic.md
    This section is updated to present a minimalist example of a Nuxt project making use of the Tailwind CSS module.

  • Added Instructions in docs/content/3.examples/2.dark-mode.md
    An example demonstrating the use of the Tailwind Dark Mode and @nuxtjs/color-mode modules is now included. Steps on how to update the tailwind.config file and colorMode module have been provided.

  • Added Live Example in docs/content/3.examples/3.nuxtlabs-ui.md & docs/content/3.examples/4.postcss-plugin.md
    They now include live examples of the NuxtLabs UI module and Nuxt Tailwind using the postcss-color-gray plugin.

  • Included Plugin Example in docs/content/3.examples/7.tailwind-icons.md
    This section now provides an example of using the tailwindcss-icons plugin.

@ineshbose
Copy link
Collaborator

Thank you very much ❤️

@ineshbose ineshbose merged commit 92b7be2 into nuxt-modules:main Aug 6, 2023
1 check failed
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.

2 participants