Skip to content

Line endings on windows break frontmatter in projectDocuments CLRF #2628

@bukowa

Description

@bukowa

I don't know how much time I have wasted on debugging line endings on Windows in many projects. It's funny, for example, in Docker where if you have entrypoint.sh with CLRF it will simply tell you that "entrypoint file not found". I found a similar error in the markdown plugin for typedoc, I always come across it wherever I go. CLRF - I will probably get this tattooed :D

Search terms

Line endings on windows break frontmatter in projectDocuments CLRF

Expected Behavior

It works.

Actual Behavior

It's broken. quick_start has CLRF below:

9f5e5e3d8933a885af58fce8cf46ea2c
badbad

Steps to reproduce the bug

I added files here: https://gist.github.com/bukowa/e9623517b7e73f2494369af98185a13f#file-quick-start-html-L54
If necessary I can probably build a full example.

Environment

  • Typedoc version: 0.26.3
  • TypeScript version: 5.5.3
  • Node.js version: v22.4.0
  • OS: Windows 10

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributors

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions