|| Basics • Experiences || Setup • Getting Started || Samples ||
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)
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.
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).
Before you get can start creating intera 5AFD ctive 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 tryglobal tool, enter the commanddotnet try -hyou 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. |
You can get started using either one of the options below.
Option1: dotnet try demo
- Create a new folder.
cdto your new folder.- Run command
dotnet try demo
Option 2: Starting from scratch.
- Go to the terminal and create a folder called
mydoc. cdto themydocfolder and create a new console app with the following command
> dotnet new console -o myAppThis will create a console app with the files myApp.csproj and Program.cs.
-
Open
mydocfolder in Visual Studio Code. -
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
```- Now, navigate back to the
mydocfolder and run the following command:
> dotnet tryYou 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 folders.
- Read our quick setup guide.