Giter Club home page Giter Club logo

codelab-starter's Introduction

A codelab starter

A starter repo to create your own codelab document(s). Provides some convenience functions to get started.

Getting started

The documentation is built using claat, the code-labs documentation tool.

PROJECT_DIR=<PROJECT_DIR>
git clone https://github.com/sramam/codelab-starter $PROJECT_DIR
cd $PROJECT_DIR
./install

Create a new markdown codelabs file

When we are documenting multiple codelabs in the same repo, this allows generation of the template file. Prompts for various fields that are configuralble

./generate [sub_project_name]

creates ./md/[sub_project_name].md

Build

./build <sub_project_name>

Serve

./serve.sh <sub_project_name>

codelab-starter's People

Contributors

sramam avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.