logo
Documentation
Installation
Initializing search
    mgrsskls/miyagi
    mgrsskls/miyagi
    • Home
    • Installation
      • Default configuration
      • Available options
      • Via config file
      • Via CLI
      • Extending a template engine
      • Starting miyagi
      • Creating a component
      • Creating mock data
      • Linting mock data
      • Creating a build
      • Introduction
      • Assets
      • Documentation
      • Info
      • Mocks
      • Schema
      • Template
    • The UI
    • Supported template engines
    • JavaScript API
      • Adding JS files
      • Adding custom CSS and JS per component
      • Extending a template engine
      • Using dark and light mode
      • Theming the UI
      • Changing the text direction
      • Changing the HTML language attribute
      • Configuring the JSON Schema validator
      • Organizing components
      • Writing mock data
      • Linting mock data
      • Changing miyagi's port
      • Adding documentation
      • Creating a design token overview
      • Navigating through miyagi
    • VS Code extension

    Installation

    miyagi can be installed from npm:

    npm i --save-dev @miyagi/core
    

    or

    yarn add --dev @miyagi/core
    

    You can also install it globally:

    npm i -g @miyagi/core
    

    or

    yarn global add @miyagi/core
    

    NOTE: miyagi does not install any template engines for you, so you still need to install them manually.

    Previous Home
    Next Default configuration
    Made with Material for MkDocs