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

Treat Xamarin .workbook files as markdown #3500

Merged

Conversation

sandyarmstrong
Copy link
Contributor

@sandyarmstrong sandyarmstrong commented Mar 2, 2017

Xamarin Workbook files are interactive coding documents for C#, serialized as
markdown files. They include a YAML front matter header block with some
metadata. Interactive code cells are included as csharp fenced code blocks.

An example can be found here:
https://github.com/xamarin/Workbooks/blob/master/csharp/csharp6/csharp6.workbook

Treated as markdown, it would appear like so:
https://gist.github.com/sandyarmstrong/e331dfeaf89cbce89043a1c31faa1297

They are becoming increasingly popular as teaching documents. There are a few hundred already in GitHub today: https://github.com/search?utf8=%E2%9C%93&q=extension%3Aworkbook+NOT+nothack&type=Code&ref=searchresults .

@sandyarmstrong
Copy link
Contributor Author

sandyarmstrong commented Mar 2, 2017

Oh, I see that samples are required now. I will add one. (EDIT: Done)

@sandyarmstrong
Copy link
Contributor Author

I do not believe the Travis build issues have anything to do with my commit?

@lildude
Copy link
Member

lildude commented Apr 20, 2017

I do not believe the Travis build issues have anything to do with my commit?

@sandyarmstrong nope, doesn't look like it. Can you please merge in master and we'll see how things play out.

Xamarin Workbook files are interactive coding documents for C#, serialized as
markdown files. They include a YAML front matter header block with some
metadata. Interactive code cells are included as `csharp` fenced code blocks.

An example can be found here:
https://github.com/xamarin/Workbooks/blob/master/csharp/csharp6/csharp6.workbook

Treated as markdown, it would appear like so:
https://gist.github.com/sandyarmstrong/e331dfeaf89cbce89043a1c31faa1297
@sandyarmstrong sandyarmstrong force-pushed the xamarin-workbooks-as-markdown branch from 4823cf2 to 3d31d3d Compare April 20, 2017 13:57
@sandyarmstrong
Copy link
Contributor Author

@lildude rebased on latest master. Looks like the build passed!

@lildude lildude merged commit 7aeeb82 into github-linguist:master Apr 20, 2017
@sandyarmstrong
Copy link
Contributor Author

Thanks! Any idea when this will hit github.com?

@lildude
Copy link
Member

lildude commented Apr 20, 2017

When I build the next release gem and create & merge the PR that updates github.com 😁. I've merged in quite a few things today and am waiting on a few nudges, so it'll probably be early next week before I even start.

One thing is for sure: it'll be before 9 May.

sandyarmstrong added a commit to sandyarmstrong/vscode that referenced this pull request Jun 5, 2018
Xamarin Workbooks are interactive coding documents that are saved as
straight-forward markdown files with a YAML front matter header block.

Here is a sample: https://github.com/xamarin/Workbooks/blob/master/csharp/csharp6/csharp6.workbook

Github has been treating them as markdown files for over a year now
(github-linguist/linguist#3500).
mjbvz pushed a commit to microsoft/vscode that referenced this pull request Jul 18, 2018
Xamarin Workbooks are interactive coding documents that are saved as
straight-forward markdown files with a YAML front matter header block.

Here is a sample: https://github.com/xamarin/Workbooks/blob/master/csharp/csharp6/csharp6.workbook

Github has been treating them as markdown files for over a year now
(github-linguist/linguist#3500).
@github-linguist github-linguist locked as resolved and limited conversation to collaborators Jun 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants