kumacss

Kuma

🐻 Pastel markdown styling framework

Description

Kuma is a simple, discrete, pastel markdown styling framework.

Live preview is available here.

Come over to our Gitter channel to share your thoughts on the project or to just say hi.

Contents

• Description
• Install
• Usage
• Building
• Team
• License

Install

npm i --save-dev kumacss

Usage

After installing simply set kuma.css as your main stylesheet.

Programmatically

Kuma can be directly linked from node_modules using the node_modules/kumacss/dist/kuma.css filepath.

const path = require('path');

const join = path.join;
const resolve = path.resolve;

const kumaCSS = 'kuma.css';
const distDir = 'node_modules/kumacss/dist';

const distPath = resolve(__dirname, distDir);
const kumaCSSPath = join(distPath, kumaCSS);

Manually

Directly link kuma.css on your doc.

<link rel="stylesheet" href="path/to/kuma.css">

Building

• Clone the repo to your local machine
• Install the dependencies npm install
• Once done editing check for errors npm test
• Run the development server npm start
• Build the preview docs npm run build
• Build Kuma npm run dist
• Clean-up compiled files npm run clean

Team

Coded with ❤ by

Klaus Sinani	Mario Sinani

License

MIT