Giter Site home page Giter Site logo

storybook_html_pugdev's Introduction

storybook_html_pugdev

a development environment by pug for [storybook for html]

Demo

  • Automatically import [tree-title.stories.pug] to [/path/to/tree-title] without writing javascript.
  • sass and stylus under the stories folder are automatically imported.
  • Display pug and html source in add-on panel and copy.
  • Knobs and testing can be written in stories.js by making pug's mixin a component.
  • Enabled to embed pug's common variables for each environment by using config.

Installation

npm i

npm script

development

npm run storybook 

【build】config → .storybook/default output-dir → public

npm run build

【build2】config → .storybook/second output-dir → docs
// for github pages

npm run build2

Components made with pug mixin

Please refer to the following link and demo

Pug's Source View Add-on

【 .stories.pug 】→ Automatically import.
【 .stories.js 】→ Set path from /stories/~

  //csf
  export const Default = () => {/../}
  Default.story = {
    parameters:{pugCode:'Examples/Media/Media.pug'}
  }

  //storiesOf
  storiesOf('Examples/Media',modules)
  .add(
    'Media',
    () => {/../},
    {
      pugCode:'Examples/Media/Media.pug'
    })

Hot reload does not work for this panel. Please reload if you want to update.

Pug's common variables

Can be set with config.
→ /.storybook/(default)/pug-data.js

//Pug's common variables
module.exports = {
  imgDir:"/images/"
}

【 .stories.pug 】→ Automatically import.
【 .stories.js 】→ Import pug-data.js and set it to renderer()

import { renderer } from 'storypug'
import pugData from '@conf/pug-data'
const { html } = renderer(pugData)

storybook_html_pugdev's People

Contributors

bigfly3 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.