This repository has been archived on 2023-02-02. You can view files and clone it, but cannot push or open issues or pull requests.
mfgames-markdown-cil/README.md

1.3 KiB

MfGames.Markdown CIL

This is a set of libraries for working with Markdown in C#. Most of the code are extensions in MarkDig, an extensible library for converting Markdown.

The library includes the following:

  • An extension for converting wiki links, such as [[MfGames]] into a link based on the title. This is for both HTML and Gemtext.
  • A output library for using MarkDig to generate Gemtext for Gemini pods.

The documentation is rather light at the moment, but the tests can show various ways of using the libraries.

Usage

These library are not on nuget.org (for various reasons). To use them, set up your NuGet.config to pull them from their repository.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <add key="mfgames.com" value="https://src.mfgames.com/api/packages/mfgames-cil/nuget/index.json" protocolVersion="3" />
  </packageSources>
  <packageSourceMapping>
    <packageSource key="nuget.org">
      <package pattern="*" />
    </packageSource>
    <packageSource key="mfgames.com">
      <package pattern="MfGames.*" />
    </packageSource>
  </packageSourceMapping>
</configuration>

The two libraries are:

  • MfGames.Markdown
  • MfGames.Markdown.Gemtext