Configure import with kyso.yaml

You can optionally add a 'kyso.yaml' file to your directory with the following options:

  • branch: this allows you to specify only a single branch which will be posted to Kyso.

  • main: Specify the main file you want your visitors to see

  • title: Specify the title of the post

  • description: Specify the description of the post

  • tags: any tags you want added to the post

  • email: an email address that a Kyso team member used to sign up to Kyso and they will be attributed as the creator on Kyso. This only applies to child posts.

  • created_at: to set the post date just add this field as a string that can be parsed by moment.js https://momentjs.com/guides/#/parsing/ This only applies to child posts.

  • updated_at: same as created_at but for when the post is updated. This only applies to child posts.

So for example if you had a directory with a 'my-article.ipynb' notebook and you wanted Kyso to only accept the staging branch you would create a 'kyso.yaml' file like the following:

title: "My awesome post"
description: "This is a description of what I did in my awesome post"
branch: staging
main: my-article.ipynb
tags:
- apples
- organges

You can also set the title and description, and preview image in the post config on Kyso.

Recommendation: Always add a title, description and preview image to your posts. You will get a ton more readers.

If you want to validate your yaml before pushing to Github - checkout this YAML Validator

YAML Header in the Notebook Itself

In the absence of any kyso.yaml file in the directory, Kyso will look for a YAML header in a notebook's metadata. This may be a better option for those of you posting ongoing projects, to which commits are made on a daily or weekly basis. Rather than manually configuring a YAML file each time, you can simply update the metadata while working in the notebook.

The example below is our YAML configs contained within 3 dashed (-) lines top and bottom, in the first Markdown cell of the notebook:

---
title: "My awesome post"
description: "This is a description of what I did in my awesome post"
branch: staging
main: my-article.ipynb
tags:
- apples
- organges
---