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.
Go to file
D. Moonfire 5229ab8521 ci: trying different woodpecker layout 2022-11-02 20:23:55 -05:00
.config build: preparing project layout 2022-09-05 22:37:35 -05:00
.husky feat: initial commit 2021-09-06 23:56:25 -05:00
scripts build: fixing typos in scripts 2022-11-02 19:42:20 -05:00
src feat: implemented wiki links for both HTML and Gemtext 2022-11-02 17:37:04 -05:00
tests feat: implemented wiki links for both HTML and Gemtext 2022-11-02 17:37:04 -05:00
.editorconfig build: preparing project layout 2022-09-05 22:37:35 -05:00
.envrc build: preparing project layout 2022-09-05 22:37:35 -05:00
.gitignore build: preparing project layout 2022-09-05 22:37:35 -05:00
.prettierignore feat: initial commit 2022-09-05 16:41:27 -05:00
.woodpecker.yml ci: trying different woodpecker layout 2022-11-02 20:23:55 -05:00
CODE-OF-CONDUCT.md feat: initial commit 2022-09-05 16:41:27 -05:00
LICENSE.txt feat: initial commit 2022-09-05 16:41:27 -05:00
MfGames.Markdown.sln feat: implemented wiki links for both HTML and Gemtext 2022-11-02 17:37:04 -05:00
MfGames.Markdown.sln.DotSettings feat: implemented wiki links for both HTML and Gemtext 2022-11-02 17:37:04 -05:00
NuGet.Config build: preparing project layout 2022-09-05 22:37:35 -05:00
README.md build: fixed setup.sh script 2022-11-02 17:59:13 -05:00
flake.lock feat: switching to .net6 2022-09-05 22:22:10 -05:00
flake.nix feat: switching to .net6 2022-09-05 22:22:10 -05:00
lefthook.yml build: preparing project layout 2022-09-05 22:37:35 -05:00

README.md

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