Skip to content

Migrate Style Guide #56

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

Merged
merged 3 commits into from
Mar 15, 2020
Merged

Migrate Style Guide #56

merged 3 commits into from
Mar 15, 2020

Conversation

phanan
Copy link
Member

@phanan phanan commented Mar 14, 2020

Closes #24.

@phanan phanan added the content Issues / PRs related to docs content label Mar 14, 2020
@phanan phanan added this to the alpha milestone Mar 14, 2020
@phanan phanan self-assigned this Mar 14, 2020
@phanan
Copy link
Member Author

phanan commented Mar 14, 2020

Page ready for review: https://deploy-preview-56--vue-next.netlify.com/style-guide/.

Copy link
Member

@NataliaTepluhina NataliaTepluhina left a comment

Choose a reason for hiding this comment

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

Great work @phanan! I've left a question regarding examples

Copy link
Member

@NataliaTepluhina NataliaTepluhina 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 the super quick fix @phanan 🚀

I've created a follow-up issue just to keep a fix in mind and I'm approving this PR 👍

Copy link
Member

@sdras sdras left a comment

Choose a reason for hiding this comment

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

This is great! Just one question. Also as mentioned by @bencodezen, we can go back in and color things well in this new version so it's super clear

@@ -0,0 +1,1872 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

(new to VuePress:) why do we need the sidebar: auto ?

Copy link
Member Author

@phanan phanan Mar 15, 2020

Choose a reason for hiding this comment

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

I'm no VuePress master either 😅 The way I understand it, for VuePress to auto-generate a sidebar from the headings of the current page, we can either:

  • set it in the global config.js file

    module.exports = {
      themeConfig: {
        sidebar: 'auto'
      }
    }
  • or, set it as the YAML front-matter per Markdown file

    ---
    sidebar: auto
    ---

Since we're already configured themeConfig.sidebar to be a custom object in our config.js (I'm not sure if it's necessary TBH), I'm going with the second option.

@phanan phanan merged commit f3f5830 into master Mar 15, 2020
@phanan phanan deleted the migration/style-guide branch March 15, 2020 20:40
TalexDreamSoul pushed a commit to Talexs/docs that referenced this pull request Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues / PRs related to docs content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate Style Guide content
3 participants