Mutagen-Modding / Mutagen

A .NET library for analyzing, creating, and manipulating Bethesda mods
GNU General Public License v3.0
121 stars 32 forks source link

Fixes list rendering in documentation #476

Closed ThePoShWolf closed 1 year ago

ThePoShWolf commented 1 year ago

I'm very excited to have found this library! After spending some time reading the documentation, I have found that lists in the Mutagen documentations aren't rendered properly in GitHub Pages, for example in index.md:

image

This PR has a very simple fix to add a preceding empty line before all markdown lists in the docs/ folder to ensure they are rendered as lists.

Accomplished with a simple regex replace:

'^([^-].*)\r\n-', '$1

-'
Noggog commented 1 year ago

Hmm, unfortunately, didn't seem to fix it on the actual site. Maybe there's something specific about mkDocs that are causing issues

EDIT: Nevermind. The homepage index was just missed, so it was still displaying messed up lists. Fixed that one as a followup