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.
Interactive .NET documentation
Try .NET enables .NET developers to write documentation containing interactive code snippets using Markdown or HTML.
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 -hto see a list of commands:
||Learn how to create Try .NET content with an interactive demo|
||Verify Markdown files in the target directory and its children.|
You can get started using either one of the options below.
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
mydocfolder 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
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 ./mydoc/Program.cs --project ./mydoc/mydoc.csproj ```
- Now, navigate back to the
mydocfolder and run the following command:
> dotnet try
You can now run your sample code in the browser.
Option 3: Explore our samples folders.
- Read our quick setup guide.