Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

docs: update vuepress docs with codesandbox starter #409

Merged
merged 1 commit into from
Mar 30, 2021
Merged

docs: update vuepress docs with codesandbox starter #409

merged 1 commit into from
Mar 30, 2021

Conversation

HoukasaurusRex
Copy link
Contributor

Added a new vuepress codesandbox starter for the vuepress chakra docs.

Description

  • Added link to codesandbox starter at the bottom of the page
  • Clarified the "using chakra components" section to explain components in vuepress's theme inheritance
  • Fixed a little extra ) in the code sample

Motivation and Context

This is intended to provide a clear way to get started with ChakraUI in a new or existing Vuepress project with a live example.

How Has This Been Tested?

The starter can successfully render basic Chakra components without completely overriding the existing Vuepress theme.

Screenshots (if appropriate):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@changeset-bot
Copy link

changeset-bot bot commented Mar 16, 2021

⚠️ No Changeset found

Latest commit: 3658bd0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Mar 16, 2021

@HoukasaurusRex is attempting to deploy a commit to the Chakra UI Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Mar 21, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

chakra-ui-vue – ./

🔍 Inspect: https://vercel.com/chakra-ui/chakra-ui-vue/E8JjeM3NxCRwbMtS9a8ZChyA8Zv5
✅ Preview: https://chakra-ui-vue-git-fork-houkasaurusrex-develop-chakra-ui.vercel.app

codebender828
codebender828 approved these changes Mar 26, 2021
View reviewed changes
Copy link
Collaborator

@codebender828 codebender828 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this @HoukasaurusRex !

@codebender828 codebender828 merged commit d058d61 into chakra-ui:develop Mar 30, 2021
@codebender828
Copy link
Collaborator

@all-contributors please add @HoukasaurusRex for platform

@allcontributors allcontributors bot mentioned this pull request Mar 30, 2021
Merged
@allcontributors
Copy link
Contributor

@codebender828

I've put up a pull request to add @HoukasaurusRex! 🎉

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@codebender828 codebender828 codebender828 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@HoukasaurusRex @codebender828