Page title is not parsed when file contains Windows line endings

Doctave / doctave

A batteries-included developer documentation site generator

https://cli.doctave.com

MIT License

549 stars 33 forks source link

Page title is not parsed when file contains Windows line endings #8

Closed ciwchris closed 2 years ago

ciwchris commented 2 years ago

When generating a new Doctave site on Windows, doctave init, the Examples page is generated with Windows line endings. These line endings prevent the title from being parsed by Doctave and instead are included as markdown content, as if it were just markdown content. The same issue occurs when generating new files on Windows, because they also contain Windows line endings. After changing the files to Unix line endings then the title is parsed by Doctave and the page's title is displayed as expected.

Screenshot 2021-10-12 at 11-54-14 examples

begleynk commented 2 years ago

Thank you Chris for such a detailed bug report! I'm going to dig into this today - my guess is that this should be a reasonably straightforward fix in the frontmatter parser.

begleynk commented 2 years ago

Unfortunately as I started working on this and pushed a test to verify the bug, GitHub decides to have an Actions outage for Windows specifically:

GitHub Support forum: https://github.community/t/github-actions-windows-down/206312
Doctave's hanging CI run: https://github.com/Doctave/doctave/actions/runs/1336532253

Will keep an eye on when this clears up.

begleynk commented 2 years ago

I'm going to create a new 0.2.1 release shortly. This bug should be fixed in that one.

Thank you again for reporting the issue!

ciwchris commented 2 years ago

Works perfect. Thanks! 🎉