claat

command
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2016 License: Apache-2.0 Imports: 27 Imported by: 0

README

Codelabs command line tool

The program takes an input in form of a resource location, which can either be a Google Doc ID, local file path or an arbitrary URL. It then converts the input into a codelab format, HTML by default.

For more info run claat help.

Install

The easiest way is to download pre-compiled binary. The binaries are available at

https://claat.storage.googleapis.com/claat-darwin-amd64
https://claat.storage.googleapis.com/claat-linux-386
https://claat.storage.googleapis.com/claat-linux-amd64
https://claat.storage.googleapis.com/claat-windows-386.exe
https://claat.storage.googleapis.com/claat-windows-amd64.exe

Alternatively, if you have Go installed and GOPATH set properly:

go get github.com/googlecodelabs/tools/claat

If none of the above works, compile the tool from source following Dev workflow instructions below.

Dev workflow

Prerequisites

  1. Install Go if you don't have it.
  2. Make sure this directory is placed under $GOPATH/src/github.com/googlecodelabs/tools.
  3. Install package dependencies with go get ./... from this directory.

To build the binary run make or make bin/claat. The latter creates the target binary, while the former will also copy it to $GOPATH/bin.

Testing is done with make test or go test ./... if preferred.

Don't forget to run make lint or golint ./... before creating a new CL.

To create cross-compiled versions for all supported OS/Arch, run make release. It will place the output in bin/claat-<os>-<arch>.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
md
Package md implements a parser for CLaaT. It expects, as input, the output of running a Markdown file through the Devsite Markdown processor.
Package md implements a parser for CLaaT. It expects, as input, the output of running a Markdown file through the Devsite Markdown processor.
Package types provide types for format-independent codelab data model.
Package types provide types for format-independent codelab data model.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL