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, as well as their checksums are available at the Releases page.
Alternatively, if you have Go installed:
go install github.com/Foundation-CCC/google-codelabs-tools/claat@latest
If none of the above works, compile the tool from source following Dev workflow instructions below.
Dev workflow
Prerequisites
- Install Go if you don't have it.
- Make sure this directory is placed under
$GOPATH/src/github.com/Foundation-CCC/google-codelabs-tools. - Install package dependencies with
go get ./...from this directory.
To build the binary, run make.
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
¶
Overview ¶
The claat command generates one or more codelabs from "source" documents, specified as either Google Doc IDs or local markdown files. The command also allows one to preview generated codelabs from local drive using "claat serve". See more details at https://github.com/Foundation-CCC/google-codelabs-tools.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
The claat command generates one or more codelabs from "source" documents, specified as either Google Doc IDs or local markdown files.
|
The claat command generates one or more codelabs from "source" documents, specified as either Google Doc IDs or local markdown files. |
|
md
Package md implements a parser for CLaaT. It expects, as input, the output of running a Markdown file through the Markdown processor.
|
Package md implements a parser for CLaaT. It expects, as input, the output of running a Markdown file through the Markdown processor. |
|
Package types provide types for format-independent codelab data model.
|
Package types provide types for format-independent codelab data model. |