Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace master with main in URLs in Docs and Code #876

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ using some simple formatting conventions. You can also author codelabs using mar
This repo contains all the tools and documentation you’ll need for building and publishing
your own codelabs.

If you're interested in authoring codelabs, create a doc following the [Codelab Formatting Guide](FORMAT-GUIDE.md).
If you're interested in authoring codelabs, create a doc following the [Codelab Formatting Guide](FORMAT-GUIDE.md).
and see the [claat](claat) directory for a detailed description of the `claat` command line tool.

Also, consider joining the [codelab-authors Google Group](https://groups.google.com/forum/#!forum/codelab-authors),
which connects you with other authors and provides updates on new releases.
which connects you with other authors and provides updates on new releases.

## What is this?

Expand Down Expand Up @@ -53,21 +53,21 @@ Check out this [excellent tutorial](https://medium.com/@zarinlo/publish-technica

1. Make one or more changes and preview your codelab, using the preview app provided by Google. To preview a codelab, install the [Preview Codelab Chrome extension](https://chrome.google.com/webstore/detail/preview-codelab/lhojjnijnkiglhkggagbapfonpdlinji) in your browser. Now you can preview a codelab directly from the Google Doc view by clicking the Chrome extension’s button, which will open a new tab to display the preview. Alternatively, navigate manually to https://codelabs-preview.appspot.com/?file_id=<google-doc-id>

1. Install the claat command -- see the [README in the claat directory](https://github.com/googlecodelabs/tools/blob/master/claat/README.md) of this repo for instructions..
1. Install the claat command -- see the [README in the claat directory](https://github.com/googlecodelabs/tools/blob/main/claat/README.md) of this repo for instructions..

1. Run the claat command to transform the doc contents into one of the supported output formats. The default supported formats are html and markdown but the claat tool supports adding additional formats by specifying a path to a Go template. For example, using the example document above:

$ claat export 1rpHleSSeY-MJZ8JvncvYA8CFqlnlcrW8-a4uEaqizPY
$ claat export 1rpHleSSeY-MJZ8JvncvYA8CFqlnlcrW8-a4uEaqizPY
ok your-first-pwapp

You can also specify a markdown document (.md file) as input. It has to adhere to the syntax conventions described [here](https://github.com/googlecodelabs/tools/tree/master/claat/parser/md)
You can also specify a markdown document (.md file) as input. It has to adhere to the syntax conventions described [here](https://github.com/googlecodelabs/tools/tree/main/claat/parser/md)

$ claat export document.md
ok your-md-based-codelab

1. Run the claat serve command.

$ claat serve
claat serve

This will start a local web server and open a browser tab to the local server. Click on the
hyperlink represent your codelab of interest to experience a fully rendered version.
Expand Down
2 changes: 1 addition & 1 deletion claat/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The following formats are built-in:
- offline (plain HTML markup for offline consumption)

Note that the built-in templates of the formats are not guaranteed to be stable.
They can be found in https://github.com/googlecodelabs/tools/tree/master/claat/render.
They can be found in https://github.com/googlecodelabs/tools/tree/main/claat/render.
Please avoid using default templates in production. Use your own copies.

To use a custom format, specify a local file path to a Go template file.
Expand Down
8 changes: 4 additions & 4 deletions sample/codelab.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here is an example image of another CodeLab that I created:

**Resources:**
* This codelab's original home is located here: [Link to Codelab](https://www.marcd.dev/codelab-4-codelab)
* The markdown for the original codelab is located here: [codelab.md](https://github.com/Mrc0113/codelab-4-codelab/blob/master/codelab.md)
* The markdown for the original codelab is located here: [codelab.md](https://github.com/Mrc0113/codelab-4-codelab/blob/main/codelab.md)
* [Google CodeLabs Tools Github](https://github.com/googlecodelabs/tools) - The repo that contains the claat tool we'll be using today
* [Google Group for CodeLab Authors](https://groups.google.com/forum/#!forum/codelab-authors) - great forum for asking questions about codelabs and discussing future functionality
* [A blog that I used when getting started with Google Codelabs](https://medium.com/@mariopce/tutorial-how-to-make-tutorials-using-google-code-labs-gangdam-style-d62b35476816)
Expand All @@ -34,7 +34,7 @@ Duration: 0:04:00

In order to create a CodeLab you need *Go* and *claat* (the codelabs command line tool) installed.

The instructions below are what worked for me on Mac, but you can also find instructions [here](https://github.com/googlecodelabs/tools/tree/master/claat)
The instructions below are what worked for me on Mac, but you can also find instructions [here](https://github.com/googlecodelabs/tools/tree/main/claat)

#### Install Go

Expand Down Expand Up @@ -185,7 +185,7 @@ Adding an image!
![https://codepen.io/tzoght/embed/yRNZaP](https://en.wikipedia.org/wiki/File:Example.jpg "Try Me Publisher")
```

More Markdown Parser examples can be found [here](https://github.com/googlecodelabs/tools/tree/master/claat/parser/md).
More Markdown Parser examples can be found [here](https://github.com/googlecodelabs/tools/tree/main/claat/parser/md).

## Export and Serve
Duration: 0:02:00
Expand Down Expand Up @@ -216,4 +216,4 @@ Now that you have the static content you can host it however you want.
One option is pushing it to github and serving it up from Netlify.

If you'd like to create your own landing page for codelabs, [like this one](https://codelabs.developers.google.com), there is a tool to do that as well!
Check it out here: [CodeLabs Site](https://github.com/googlecodelabs/tools/blob/master/site/README.md)
Check it out here: [CodeLabs Site](https://github.com/googlecodelabs/tools/blob/main/site/README.md)
2 changes: 1 addition & 1 deletion site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The project requires the following major dependencies:
- [Go](https://golang.org/dl/) language
- [Node.js](https://nodejs.org/en/download/) v10+ and [npm](https://www.npmjs.com/get-npm)
- [gsutil](https://cloud.google.com/storage/docs/gsutil_install)
- [claat](https://github.com/googlecodelabs/tools/tree/master/claat#install)
- [claat](https://github.com/googlecodelabs/tools/tree/main/claat#install)

With Node installed, run `npm install` in the root of the `site` (this folder):

Expand Down