Skip to content

[FEATURE] Allow specifying custom paths to specially handled files #1197

@ocket8888

Description

@ocket8888
Overview of the feature

Allow specifying e.g. --changelogPath to specify a path to a file to use as the CHANGELOG.md for files like it that are specially handled. I know of:

  • LICENSE
  • CONTRIBUTING
  • TODO
  • README
  • CHANGELOG
Motivation for or Use Case

My project is a mono-repo that contains many different components of a large system. The front-end that I want documented is covered by the repo-wide LICENSE.md file, but should use its own README. The two are in different directories, which compodoc doesn't support.

Related issues

None afaik

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions