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

Add initialization command #1252

Closed
yyx990803 opened this issue Aug 30, 2022 · 0 comments · Fixed by #2020
Closed

Add initialization command #1252

yyx990803 opened this issue Aug 30, 2022 · 0 comments · Fixed by #2020

Comments

@yyx990803
Copy link
Member

yyx990803 commented Aug 30, 2022

  • Add a new command: vitepress init
    • Users can invoke this after installing vitepress with npx vitepress init
  • Ask a few CLI questions:
    • Root of your markdown files (default: cwd)
    • Site title / description
    • Use the default theme / default theme + customization / complete custom theme?
    • Inject npm scripts? (should be based on root)
  • Scaffold the project in desired root
    • .vitepress/config.js with title, description, and a comment with link to app config docs
    • example.md with examples of built-in markdown features
    • If default theme:
      • index.md w/ example home page frontmatter
      • Example nav / sidebar config with links to example.md and VitePress docs
      • If default theme + customization: add .vitepress/theme/index.js and .vitepress/theme/style.css with theme slot and CSS var customization exmaples
    • If custom theme:
      • add .vitepress/theme/index.s + .vitepress/theme/Layout.vue for a simple custom theme example
@yyx990803 yyx990803 added this to the v1.0.0 milestone Aug 30, 2022
@kiaking kiaking removed this from the v1.0.0 milestone Feb 27, 2023
yyx990803 added a commit that referenced this issue Mar 2, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants