-
-
Notifications
You must be signed in to change notification settings - Fork 416
Description
Overview of the issue
The issue is that after changes in 1.1.27 the markdown pages like CHANGELOG.md, CONTRIBUTING.md and LICENSE.md now they are generated but not presented in the menu.
Operating System, Node.js, npm, compodoc version(s)
MacOS: 15.7.1
Node.js: 22.15.0
NPM: 10.9.2
Compodoc: 1.30.0
Angular configuration, a package.json file in the root folder
No error in logs, just the pages are not present in menu.
Compodoc installed globally or locally ?
Installed locally
If possible sourcecode of the file where it breaks
It's not breaking the code but it's not presenting the pages in menu
If possible your terminal logs before the error
No error
Motivation for or Use Case
In previous versions these pages were presented and. now they are gone and my users do not know what are the last changes in my library.
Reproduce the error
Pre-requisites:
- Have an Angular app/library project with Compodoc installed.
- There must be a CHANGELOG.md file at the root of the project.
Steps:
- Run Compodoc
Outcome:
- CHANGELOG is found and generated as html at the root of the documentation
- CHANGELOG is not available in the menu to select it.
Related issues
NO
Suggest a Fix
There was a piece of code removed in version 1.1.27 that has caused this issue.
Previous code: https://github.com/compodoc/compodoc/blob/86655ee833c50ae4b753a92104e56229c0226152/src/app/application.ts
Configuration.mainData.markdowns.push({
name: markdowns[i],
uppername: markdowns[i].toUpperCase(),
depth: 0,
pageType: COMPODOC_DEFAULTS.PAGE_TYPES.ROOT
});
It can be fixing adding the missing code again in line 367