question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[BUG] README.md is broken in compodoc but correct on GitHub

See original GitHub issue
Overview of the issue

When generating the documentation with compodoc, markdown in general is completely broken.
The perfect example is README.md, which looks fine directly on GitHub, but it’s broken in compodoc generated page.

I even tried to change my README.md completely to the same as on the following repo: https://github.com/compodoc/compodoc-demo-todomvc-angular

Operating System, Node.js, npm, compodoc version(s)
  • OSX
  • node v10.15.1
  • npm 6.9.0
  • yarn 1.15.2
  • compodoc 1.1.9
Angular configuration, a package.json file in the root folder

https://raw.githubusercontent.com/klemenoslaj/ng-action-outlet/compodoc-broken-markdown/package.json

Compodoc installed globally or locally ?

Locally.

If possible sourcecode of the file where it breaks

Full sourcecode available in the repo mentioned in the next section “Reproduce the error”.

Reproduce the error

To reproduce the problem:

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:6
  • Comments:8 (2 by maintainers)

github_iconTop GitHub Comments

3reactions
vogloblinskycommented, Jun 13, 2019

I will release a new version next week

2reactions
vogloblinskycommented, Jul 7, 2019

Yep i will release a new version tonight

Read more comments on GitHub >

github_iconTop Results From Across the Web

[BUG] Compodoc do not use the right readme.md as ... - GitHub
Overview of the issue I need to start compodoc from a folder which contain a readme.md but the project target is in another...
Read more >
[BUG] @example sections not formatted correctly #304 - GitHub
Overview of the issue @example code is incorrectly formatted. Html tags are displaying, " and other characters have been translated and ...
Read more >
[FEATURE] : Embed images in markdown · Issue #71 - GitHub
I'm trying unsuccessfully to embed images into the various README.md files in my documentation. Is this possible?
Read more >
[BUG] Code blocks are not properly rendered in the README ...
Hi, you have to use the GitHub Flavored Markdown . There is a problem in version 1.1.9 (check this), but if you use...
Read more >
[BUG] Support README.md in Workspace projects (apps and ...
It is now a default option for Angular CLI v6. However, I use nrwl.io Nx workspace which is very similar. Compodoc searches for...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found