csharp-MarkdownWriter
1.0.0
dotnet add package csharp-MarkdownWriter --version 1.0.0
NuGet\Install-Package csharp-MarkdownWriter -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="csharp-MarkdownWriter" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add csharp-MarkdownWriter --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: csharp-MarkdownWriter, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install csharp-MarkdownWriter as a Cake Addin
#addin nuget:?package=csharp-MarkdownWriter&version=1.0.0
// Install csharp-MarkdownWriter as a Cake Tool
#tool nuget:?package=csharp-MarkdownWriter&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MarkdownWriter
Library for creating Markdown files in c#
Usage
Create an instance of the Markdown class with the name of the target file <br>
var md = new Markdown("EXAMPLE");
Add the necessary elements to your file using functions from Docs <br>
md.H1("Header");
md.LineBreak();
md.Text("Hello");
- Save your file
await md.SaveAndWrite();
Your file will be saved as EXAMPLE.md
in the program execution location
Docs
Text(string text)
TaskList(string text, bool @checked = false)
Table(List<Table> tables)
UnorderedList(List<ListItem> listItems)
OrderedList(List<ListItem> listItems)
Link(string text, string url)
LineBreak()
Image(string text, string path)
H1(string text)
H2(string text)
H3(string text)
H4(string text)
H5(string text)
H6(string text)
Italic(string text)
Bold(string text)
Code(string code)
Blockquote(string text)
async SaveAndWrite()
Example
using MarkdownWriter;
using MarkdownWriter.data;
var md = new Markdown("EXAMPLE");
// Table
var table = new List<Table>()
{
new Table() { Header = "A1", Values = new List<string>() { "val1", "val2", "val3" } },
new Table() { Header = "B1", Values = new List<string>() { "val4", "val5", "val6" } },
new Table() { Header = "C1", Values = new List<string>() { "val7", "val8", "val9" } }
};
md.Table(table);
// Tasklist
md.TaskList("task1", true);
md.TaskList("task2");
// List
var list = new List<ListItem>()
{
new ListItem() { Value = "a", Child = new List<ListItem>() { new ListItem() { Value = "b" } } },
new ListItem() { Value = "c", Child = new List<ListItem>() { new ListItem() { Value = "d" }, new ListItem() { Value = "2" } } },
new ListItem() { Value = "e" },
new ListItem() { Value = "f" },
new ListItem() { Value = "g", Child = new List<ListItem>() { new ListItem() { Value = "x" } } },
new ListItem() { Value = "i" }
};
md.UnorderedList(list);
md.OrderedList(list);
// Linebreak
md.LineBreak();
// Code
md.Code("<script>alert()</script>");
// Header
md.H1("Header");
// Link
md.Link("Github", "https://github.com/KimPiks/");
md.LineBreak();
// Text
md.Text("Text");
// Blockquotes
md.Blockquote("Quote");
// Images
md.Image("Img", "https://avatars.githubusercontent.com/u/35846232?v=4");
md.LineBreak();
// You can also combine functions in this way to simplify notation
md.Italic("Some").LineBreak().Bold("text" ).Text("sth");
await md.SaveAndWrite();
For example, the generated file can be found at here
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 204 | 2/6/2023 |