Skip to content
Try .NET is an interactive documentation generator for .NET Core.
Branch: master
Clone or download
Pull request Compare This branch is 49 commits behind dotnet:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
Samples
LICENSE
README.md

README.md

Try .NET dotnet bot in space

|| BasicsExperiences || SetupGetting Started || Samples ||

Try_.NET Enabled

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.

What is the repo for?

  • A place where you can post issues about Try .NET.
  • Note: The code for Try .NET is not currently hosted on GitHub.(Coming soon)

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 in the browser. Try NET_online

Interactive .NET documentation

Try .NET enables .NET developers to write documentation containing interactive code snippets using Markdown or HTML.

To make your Markdown files interactive, you will need the .NET Core 3.0 SDK, the dotnet try global tool (coming soon) and Visual Studio, VS Code, or another editor of your choice. interactive_doc

Setup

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

  • .NET Core 3.0 SDK
  • [dotnet try global tool] (coming soon) Once you have successfully installed dotnet try, enter the command dotnet try -h to 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 by running the following command:
> dotnet new console -o myApp

This will create a console app with the files mydoc.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 ./mydoc/Program.cs --project ./mydoc/mydoc.csproj
```
  1. Now, navigate back to the mydoc folder and run the following command:
> dotnet try

You can now run your sample code in the browser.

Option 3: Explore our samples folders.

You can’t perform that action at this time.