https://github.com/visual-framework/create-vf-project
A template to create a new vf-eleventy project interactively.
https://github.com/visual-framework/create-vf-project
Last synced: 3 months ago
JSON representation
A template to create a new vf-eleventy project interactively.
- Host: GitHub
- URL: https://github.com/visual-framework/create-vf-project
- Owner: visual-framework
- License: mit
- Created: 2019-06-26T09:34:59.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-01T20:04:11.000Z (3 months ago)
- Last Synced: 2026-01-07T04:38:52.953Z (3 months ago)
- Language: JavaScript
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-vf-project
Helps to create a new [Visual Framework](https://visual-framework.github.io/vf-welcome/)-based project.
## Usage
`yarn create @visual-framework/vf-project {your-new-site-name} {site-type}`
- `{your-site-name}` will be the name of the destination directory
- `{site-type}` can be any of the below options
### Supported options
- Generic templates
- Generic build environments: [`vf-build-boilerplate`](https://github.com/visual-framework/vf-build-boilerplate)
- Eleventy projects: [`vf-eleventy`](https://github.com/visual-framework/vf-eleventy)
- Design system: [`vf-demo-design-system`](https://github.com/visual-framework/vf-demo-design-system)
- Organisation specific-implementations
- Eleventy projects
- [`embl-eleventy`](https://github.com/embl-communications/embl-eleventy)
- [`ebi-eleventy`](https://github.com/ebiwd/ebi-eleventy-boilerplate)
### Example
To make a [`vf-eleventy`](https://github.com/visual-framework/vf-eleventy) based project:
```
yarn create @visual-framework/vf-project your-new-site-name vf-eleventy
```
## Troubleshooting
If you're having trouble with `yarn create` you can also try:
- `npx @visual-framework/create-vf-project {your-new-site-name} {site-type}`
- `npx @visual-framework/create-vf-project testproject vf-eleventy`
## Developing the template
1. Make any needed edits
1. Bump the version number
1. Run `yarn install`
1. `npm publish`
### Locally testing
To test before publishing to npm:
```
yarn start test-site-name vf-eleventy
```