@deepakvishwakarma/node-claat

0.2.0 • Public • Published

summary: How to use nodejs CodeLabs id: how-to-use-nodejs-codelab category: nodejs tags: medium status: Published authors: Deepak Feedback Link: https://github.com/deepakshrma/googles-codelabs

How to use nodejs CodeLabs Build Status

Overview

Duration: 2

What is nodejs CodeLabs

Go Lang claat tool replica written in node js, using marked parser

Documents: CodeLabs Docs

How to install

Duration: 2

You can either install as CLI or nodejs module

Install as CLI

npm install -g @deepakvishwakarma/node-claat

##OR

npm install -g git+ssh://git@github.com/deepakshrma/googles-codelabs.git

How to create codelab docs

Duration: 5

Create a folder[docs]

md codelabs
cd codelabs
md docs
cd docs

Create a md file

echo 'summary: This is going to be Awesome
id: this-going-to-be-awesome
category: doc
tags: medium
status: Published
authors: Deepak
Feedback Link: https://github.com/deepakshrma/googles-codelabs

## This is going to be Awesome

<!-- ------------------------ -->

## Overview

Duration: 1

### What is nodejs CodeLabs
```js
function isPageBreak(token) {
  return (
    token.type == "html" &&
    token.raw.indexOf("<!--") === 0 &&
    token.raw.includes("-->")
  );
}
```' > this-is-going-to-be-awesome.md

Run commandline

cd .. # move to home folder codelabs
ls # you will see docs folder here
node-claat --docs docs

How to contribute

Duration: 10

Prerequisite:

  • NodeJS 12.16.2 LTS or above
  • Basic knowledge of nodejs
  • ES2015 and above
git clone https://github.com/deepakshrma/googles-codelabs.git
npm install

npm run example
npm run serve

Write Test case and run:

Write test cases in test folder

npm run test:watch

## OR coverage

npm run test

Thanks For using

Duration: 1

Now you can run and see output using any static server

http-server

open browser:

open http://localhost:8080/this-is-going-to-be-awesome/#0

Thanks you for using! Work is still in progress. Keep supporting!

For more visit: CodeLabs

Readme

Keywords

none

Package Sidebar

Install

npm i @deepakvishwakarma/node-claat

Weekly Downloads

1

Version

0.2.0

License

(ISC OR GPL-3.0)

Unpacked Size

34.7 kB

Total Files

14

Last publish

Collaborators

  • deepakvishwakarma