Skip to content
Try .NET is an interactive documentation generator for .NET Core.
Branch: master
Clone or download
Latest commit 8e472b4 Jun 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update bug_report.md May 20, 2019
.vscode Build client and js api (#234) Jun 3, 2019
FSharpWorkspaceShim fix fsharp for ncrunch in 2019 (#292) Jun 20, 2019
MLS.Agent.Tests ensure packages are built Jun 17, 2019
MLS.Agent.Tools Don't create console in package registry Jun 11, 2019
MLS.Agent update buildalyzer to 2.3.0 (#288) Jun 18, 2019
MLS.Blazor Add the sdk version May 22, 2019
MLS.PackageTool update System.CommandLine to 0.3.0-alpha.19315.2 Jun 17, 2019
MLS.Repositories.Tests open source code May 15, 2019
MLS.Repositories open source code May 15, 2019
Microsoft.DotNet.Try.Client force service collection to be passed in Jun 17, 2019
Microsoft.DotNet.Try.Jupyter.Tests make protocol object immutable Jun 17, 2019
Microsoft.DotNet.Try.Jupyter refactor methods Jun 17, 2019
Microsoft.DotNet.Try.Markdown.Tests Feature/enable math (#243) May 31, 2019
Microsoft.DotNet.Try.Markdown update System.CommandLine to 0.3.0-alpha.19315.2 Jun 17, 2019
Microsoft.DotNet.Try.Project.Tests initial support for F# (#237) Jun 6, 2019
Microsoft.DotNet.Try.Project initial support for F# (#237) Jun 6, 2019
Microsoft.DotNet.Try.ProjectTemplate.Tests Move to 3.0 sdk for the template (#272) Jun 18, 2019
Microsoft.DotNet.Try.ProjectTemplate/Tutorial Move to 3.0 sdk for the template (#272) Jun 18, 2019
Microsoft.DotNet.Try.Protocol.ClientApi add langauge to protocol objects Jun 5, 2019
Microsoft.DotNet.Try.Protocol.Tests initial support for F# (#237) Jun 6, 2019
Microsoft.DotNet.Try.Protocol read only region with roundtrip emits replace injection point Jun 11, 2019
Microsoft.DotNet.Try.Styles Build client and js api (#234) Jun 3, 2019
Microsoft.DotNet.Try.js force service collection to be passed in Jun 17, 2019
PackageTool.Tests CR feedback Jun 7, 2019
Samples update System.CommandLine to 0.3.0-alpha.19315.2 Jun 17, 2019
WasmCodeRunner.Tests open source code May 15, 2019
WasmCodeRunner update System.CommandLine to 0.3.0-alpha.19315.2 Jun 17, 2019
WorkspaceServer.Tests test timeouts Jun 24, 2019
WorkspaceServer test timeouts Jun 24, 2019
docs update buildalyzer to 2.3.0 Jun 18, 2019
eng add microsoft as author (#291) Jun 19, 2019
.editorconfig Use pipleline approach for projectAsset (#236) May 29, 2019
.gitignore Build client and js api (#234) Jun 3, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md May 15, 2019
Directory.Build.props open source code May 15, 2019
Directory.Build.targets open source code May 15, 2019
DotNetTry.sln initial support for F# (#237) Jun 6, 2019
DotNetTry.sln.DotSettings wip Jun 21, 2019
DotNetTry.v3.ncrunchsolution Use pipleline approach for projectAsset (#236) May 29, 2019
License.txt open source code May 15, 2019
NuGet.config fix file casing for linux May 15, 2019
README.md Minor typo in README.md May 21, 2019
azure-pipelines.yml ensure sdk 2.1.503 is installed for all builds (#269) Jun 11, 2019
build.cmd Build client and js api (#234) Jun 3, 2019
build.sh Build client and js api (#234) Jun 3, 2019
global.json initial support for F# (#237) Jun 6, 2019
internal-sha.txt Merged PR 1685188: Make package tools easier to understand May 20, 2019
restore.cmd Build client and js api (#234) Jun 3, 2019
restore.sh Build client and js api (#234) Jun 3, 2019
test.cmd Build client and js api (#234) Jun 3, 2019
test.sh Build client and js api (#234) Jun 3, 2019

README.md

Try .NET dotnet bot in space

|| BasicsContribution GuidelinesExperiences || SetupGetting Started || Samples ||

Try_.NET Enabled

Build Status

Basics

What is Try .NET: Try .NET is an interactive documentation generator for .NET Core.

Please Note: At the moment Try .NET only works with C# documentation.

Contribution Guidelines

As we are still in the early stages of our development, we are unable to take any feature PRs at the moment but, we do intend to do this in the future. Please feel free to file any bugs reports under our issues. And if you have any feature suggestion, please submit them under our issues using the community suggestions label.

Experiences

Use Try .NET to create executable C# snippets for your websites or, interactive markdown files that users can run on their machine.

Websites

Microsoft Docs uses Try .NET to create interactive documentation. Users can run and edit code all in the browser. Try NET_online

Interactive .NET documentation

Try .NET enables .NET developers to create interactive markdown files. To make your markdown files interactive, you will need to .NET Core 3.0 SDK, the dotnet try global tool(coming soon) and Visual Studio / VS Code(or any other editor of your choice). interactive_doc

Setup

Before you get can start creating interactive documentation, you will need to install the following:

dotnet tool install --global dotnet-try --version 1.0.19264.11

Updating to the latest version of the tool is easy just run the command below

dotnet tool update -g dotnet-try

Once you have successfully installed dotnet try global tool, enter the command dotnet try -h you will see a list of commands:

Command Purpose
demo Learn how to create Try .NET content with an interactive demo
verify Verify Markdown files in the target directory and its children.

Getting Started

You can get started using either one of the options below.

Option1: dotnet try demo

  • Create a new folder.
  • cd to your new folder.
  • Run command dotnet try demo

Option 2: Starting from scratch.

  1. Go to the terminal and create a folder called mydoc.
  2. cd to the mydoc folder and create a new console app with the following command
   > dotnet new console -o myApp

This will create a console app with the files myApp.csproj and Program.cs.

  1. Open mydocfolder in Visual Studio Code.

  2. Create a file called doc.md. Inside that file, add some text and a code fence:

# My Interactive Document:

```cs --source-file ./myApp/Program.cs --project ./myApp/myApp.csproj
```
  1. Now, navigate back to the mydoc folder and run the following command:
     > dotnet try

You have created your first C# interactive developer experience. You should now be able to run your console app and see the result in the browser.

Option 3: Explore our samples Branch.

  • Clone this repo(checkout the samples branch git checkout samples)
  • Read our quick setup guide.
You can’t perform that action at this time.