Giter Club home page Giter Club logo

shaco's Introduction

Shaco

A static site generator(Base on Vite)

Usage

# install
pnpm i shaco-ssg

# cli
shaco dev [dir]
## preview
shaco preview [dir]
## build
shaco build [dir]

For Example

shaco build docs Dir config : docs/config.ts

import { defineConfig } from '../dist'

export default defineConfig({
  title: 'xxx',
  themeConfig: {
    nav: [
      { text: 'Index', link: '/' },
      { text: 'Introduction', link: '/guide/' }
    ],
    sidebar: {
      '/guide/': [
        {
          text: 'Introduction',
          items: [
            {
              text: 'Touma Kamijou',
              link: '/guide/a'
            },
            {
              text: 'Uiharu Kazari',
              link: '/guide/b'
            },
            {
              text: 'Misaka Imouto',
              link: '/guide/c'
            }
          ]
        }
      ]
    }
  }
})

homePage content: docs/index.mdx

page conent: docs/guide/index.mdx / docs/guide/b.tsx ···(can use .jsx/.tsx/.md/.mdx)

ref: /docs dir (use theme-default)

Show Case

Dev

pnpm i
# link to local
npm link

# compiler
pnpm run start

# test:unit
pnpm test:unit

# test:e2e
pnpm test:e2e

# release
pnpm release [--dry]

# run
shaco dev [dir]
## preview
shaco preview [dir]
## build
shaco build [dir]

unit test ✅

e2e test ✅

release flow

License

MIT

Changelog

Have fun!

shaco's People

Contributors

laclys avatar

Stargazers

 avatar

Watchers

 avatar  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.