2.0.0-alpha.2 • Published 5 years ago

@visual-framework/vf-demo-desing-system v2.0.0-alpha.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 years ago

Eleventy boilerplate for Visual Framework 2.0

This demonstrates how a design system can be built using the the Visual Framework component system.

You this if you want:

  • a highly componentised structure for your design system and documentation
  • a documentation site powered by the Eleventy static site generator
  • access to the Visual Framework component system
  • a /components url to document and demonstrate all components available

If you only need to integrate Visual Framework components, you can add them individually to any npm-based project or use the simpler VF Eleventy boilerplate.

How to use this template

There are two methods:

  1. An interactive npm template RECOMMENDED
    • If you don't have npm, install it
    • The create-vf-eleventy project allows you to interactively create a new site by typing npm init @visual-framework/vf-eleventy your-new-site-name vf-demo-design-system
    • Follow the prompts
  2. GitHub templates

Configuring and developing

Follow the guide.