vuepress / create-vuepress Goto Github PK
View Code? Open in Web Editor NEWScaffolding out a VuePress docs, blog, repro repo or other interesting things
License: MIT License
Scaffolding out a VuePress docs, blog, repro repo or other interesting things
License: MIT License
🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨
To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.
Since we didn’t receive a CI status on the greenkeeper/initial
branch, it’s possible that you don’t have CI set up yet.
We recommend using:
If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/
.
Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.
Hi, I'm trying to contribute to this project, but get stuck at how to develop this project locally.
I make some changes locally and want to test things out before making a pull request. Any suggestions about how can I do that?
The only way I think of is creating a new npm registry, is there a better way?
Problem
Not able to scaffold the vuepress ( docs nor blog) template using create-vupress plugin
Enviroment
how to reproduce
Install the create-vuepress pluging and tyr to run it.
Any help where I can look for any logs?
If user follow the current Getting Started guide https://vuepress.vuejs.org/guide/getting-started.html#quick-start and choose the "blog" boilerplate type. It generate some sample posts that contains wrong "tag" in frontmatter section. Because of this, the "Tags" page in navigation is displaying blank page. To fix it, users need to replace "tag" to "tags" on all sample posts.
Example of run output:
$ yarn create vuepress my-blog
yarn create v1.22.4
[1/4] 🔍 Resolving packages...
[2/4] 🚚 Fetching packages...
[3/4] 🔗 Linking dependencies...
[4/4] 🔨 Building fresh packages...
success Installed "[email protected]" with binaries:
- create-vuepress
? Select the boilerplate type blog
? What's the name of your project? my-blog
? What's the description of your project?
? What's your email?
? What's your name?
? What's the repo of your project.
create my-blog/package.json
create my-blog/.gitignore
create my-blog/blog/_posts/2018-11-7-frontmatter-in-vuepress-2.md
create my-blog/blog/_posts/2018-11-7-frontmatter-in-vuepress-3.md
create my-blog/blog/_posts/2018-11-7-frontmatter-in-vuepress.md
create my-blog/blog/_posts/2019-2-26-markdown-slot-2.md
create my-blog/blog/_posts/2019-2-26-markdown-slot-3.md
create my-blog/blog/_posts/2019-2-26-markdown-slot-4.md
create my-blog/blog/_posts/2019-2-26-markdown-slot.md
create my-blog/blog/_posts/2019-5-6-writing-a-vuepress-theme-2.md
create my-blog/blog/_posts/2019-5-6-writing-a-vuepress-theme-3.md
create my-blog/blog/_posts/2019-5-6-writing-a-vuepress-theme-4.md
create my-blog/blog/_posts/2019-5-6-writing-a-vuepress-theme.md
create my-blog/blog/.vuepress/components/demo-component.vue
create my-blog/blog/.vuepress/components/Foo/Bar.vue
create my-blog/blog/.vuepress/components/OtherComponent.vue
create my-blog/blog/.vuepress/config.js
create my-blog/blog/.vuepress/enhanceApp.js
create my-blog/blog/.vuepress/styles/global.styl
create my-blog/blog/.vuepress/styles/index.styl
create my-blog/blog/.vuepress/styles/palette.styl
create my-blog/README.md
📋 Copied to clipboard, just use Ctrl+V
✨ File Generate Done
✨ Done in 49.50s.
Here is a sample of posts that has the wrong "tag" used:
$ head my-blog/blog/_posts/2018-11-7-frontmatter-in-vuepress-2.md
---
date: 2018-11-7
tag:
- frontmatter
- vuepress
author: ULIVZ
location: Hangzhou
---
I believe this is an issue with the scaffolding code and not vuepress itself. I made a new vuepress site using the blog app and when I run yarn dev
I get this:
/m/c/p/v/d/test1 yarn dev 08:41:03
yarn run v1.12.3
$ vuepress dev blog
Extracting site metadata...Error: [vuepress] Failed to load custom theme "@vuepress/theme-blog". File vuepress-theme-@vuepress/theme-blog/Layout.vue does not exist.
at resolveOptions (/home/ray/.npm-global/lib/node_modules/vuepress/lib/prepare.js:132:15)
at prepare (/home/ray/.npm-global/lib/node_modules/vuepress/lib/prepare.js:37:25)
at dev (/home/ray/.npm-global/lib/node_modules/vuepress/lib/dev.js:21:25)
at args (/home/ray/.npm-global/lib/node_modules/vuepress/bin/vuepress.js:104:12)
at Command.program.command.description.option.option.action (/home/ray/.npm-global/lib/node_modules/vuepress/bin/vuepress.js:31:21)
at Command.listener (/home/ray/.npm-global/lib/node_modules/vuepress/node_modules/commander/index.js:315:8)
at Command.emit (events.js:182:13)
at Command.parseArgs (/home/ray/.npm-global/lib/node_modules/vuepress/node_modules/commander/index.js:651:12)
at Command.parse (/home/ray/.npm-global/lib/node_modules/vuepress/node_modules/commander/index.js:474:21)
at Object.<anonymous> (/home/ray/.npm-global/lib/node_modules/vuepress/bin/vuepress.js:96:9)
Done in 2.60s.
🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨
To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.
Since we didn’t receive a CI status on the greenkeeper/initial
branch, it’s possible that you don’t have CI set up yet.
We recommend using:
If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/
.
Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.
It would be great to have a boilerplate option that would create the scaffold for a project with a custom theme. That is including the theme folder in the .vuepress directory and a few example files.
I personally think that this would make it easier to start creating a theme by providing a simple entry point and a well defined structure.
Though I don't have much experience in writing command line utilities or file generators, but would be happy to set aside some time to work on it if this feature is something that you think would be in line with the goals of the project.
https://github.com/ulivz/create-vuepress/blob/master/lib/generators/blog/templates/_.gitignore
->
https://github.com/ulivz/create-vuepress/blob/master/lib/generators/blog/templates/_gitignore
otherwise gitignore file with two dots
vuepress-theme-blog v2.0.0
Turn default frontmatter key to tags instead of tag/tags
Do we need to pre-install something (of course, a part yarn) to be able to run the create?
I created an empty folder and cd into new folder
Then
yarn create vuepress
But it did nothing. Nothing at all. No error, too,
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.