Skip to content

ulkajs/ulka

Repository files navigation

Ulka logo

Ulka

A simple, fast and lightweight static site generator written in javascript.


NPM MIT CI PRs welcome! PRs welcome!

🚀 Getting Started

  1. Create new ulka site.

    # with npm
    npm init ulka
    
    # with yarn
    yarn create ulka

    Then chose the template and project name.

    OR you can directly specify project name and template

     # with npm
     npm init ulka my-blog -- --template default-blog
    
     # with yarn
     yarn create ulka my-blog --template default-blog
  2. Navigate to project name and install dependencies.

     cd my-blog
    
     # with npm
     npm install
    
     # with yarn
     yarn install
  3. Build your project.

    # with npx
    npx ulka # build the project
    npx ulka -w # build and watch
    
    # with yarn
    yarn ulka # build the project
    yarn ulka -w # build and watch

Documentation

Visit ulka.js.org for documentation and tutorial.

License

MIT