Skip to content

miyagi-dev/miyagi

Repository files navigation

miyagi

miyagi

miyagi is a component development tool for JavaScript templating engines.

Benefits

  • No overhead in your project: miyagi only needs one configuration file.
  • Works with any directory structure (as long as you have one folder per component).
  • Helps you developing your components encapsulated.
  • Mock data (static or dynamic) allows developing independently from a backend.
  • Validates your mock data against your JSON schema files.
  • Documentation of your components using markdown.
  • You can customize the layout, so it fits the design of your project.
  • Use any kind of templating engine by providing your own render function.
  • Allows creating a static build.
  • Lots of functionality invokable via CLI or JavaScript API.
  • Automatically created design tokens overview based on CSS custom properties.

Requirements

  • NodeJS 20.11.0 or higher

Demos

Handlebars

handlebars.demos.miyagi.dev (Code: https://github.com/miyagi-dev/demos/tree/main/handlebars)

Web Components

web-components.demos.miyagi.dev (Code: https://github.com/miyagi-dev/demos/tree/main/web-components)

Documentation

https://docs.miyagi.dev

Sponsor

Factorial