npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mobilabs/kasar

v2.5.2

Published

View-powered Static Website Generator

Downloads

19

Readme

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.