https://github.com/ulkajs/ulka

A simple and fast static site generator written in typescript.
https://github.com/ulkajs/ulka

blog blog-engine documentation-generator javascript ssg static-site-generator ulka

Last synced: 4 days ago
JSON representation

A simple and fast static site generator written in typescript.

• Host: GitHub
• URL: https://github.com/ulkajs/ulka
• Owner: ulkajs
• License: mit
• Created: 2021-01-26T17:06:36.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-17T13:00:28.000Z (10 months ago)
• Last Synced: 2024-09-25T22:40:34.261Z (8 days ago)
• Topics: blog, blog-engine, documentation-generator, javascript, ssg, static-site-generator, ulka
• Language: TypeScript
• Homepage: https://ulka.js.org
• Size: 1.93 MB
• Stars: 19
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  



Ulka

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



















## 🚀 Getting Started

1. Create new ulka site.

   ```sh

   # 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

   ```sh

    # with npm

    npm init ulka my-blog -- --template default-blog

    # with yarn

    yarn create ulka my-blog --template default-blog

   ```

1. Navigate to project name and install dependencies.

   ```sh

    cd my-blog

    # with npm

    npm install

    # with yarn

    yarn install

   ```

1. Build your project.

   ```sh

   # 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](https://ulka.js.org) for documentation and tutorial.

## License

[MIT](https://mit-license.org/)