@mobilabs/kasar

2.5.1 • Public • Published

Kasar

NPM version GitHub last commit Github workflow Test coverage npm bundle size License

Kasar is static site generator. It creates a static website from markdown or HTML pages. It is powered by npm scripts and RView.

The advantages of the static websites are their responsiveness, the limited server resources needed and the simplicity of installation.

Thus, you can run your website on cheapest web servers and you just need to copy and paste a folder to get your web server up and running!

How to install Kasar

You first have to create an empty NPM project. When it is done, install Kasar with the command:

npm install @mobilabs/kasar --save

Then, you should add the three following scripts in the script section of the file package.json:

{
  "scripts": {
    "kasar:init": "kasar init --theme $1",
    "kasar:build": "kasar build",
    "kasar:start": "kasar serve --port $1"
  }
}

Quick Startup

How to create your project

You have to run the following command:

npm run kasar:init

The script creates the folder site with the following tree:

site
  |_ .kasar
  |_ img
  |_ js
  |_ php
  |_ styles
  |_ tobuildweb
  |_ vendor
  |_ webpages
  |_ config.js

Fill the vendor folder

The start theme requires the Montserrat fonts and Highlight.js as a code syntax highlighter. These packages must be downloaded from their respective websites. The readme file in the vendor folder gives instructions how to proceed.

How to build your website

Just type the following command:

npm run kasar:build

A new folder _dist appears under site:

site
  |_ _dist
  |_ .kasar
  |_ img
  |_ ...

This folder contains all the files requires to run a website (index.html, css, js, etc.).

How to run your website on your machine

Just type the following command:

npm run kasar:start

This command launches a local web server running at the address http://localhost:8080 that displays the website on your browser.

On the displayed page, click the button click me to read the detailed documentation.

License

MIT.

Readme

Keywords

Package Sidebar

Install

npm i @mobilabs/kasar

Weekly Downloads

40

Version

2.5.1

License

MIT

Unpacked Size

13.9 MB

Total Files

522

Last publish

Collaborators

  • jclo