Skip to content

Support for custom output directory structure #2111

@NullVoxPopuli

Description

@NullVoxPopuli

Search terms

Cloudflare pages

Expected Behavior

Visiting a link for a function works

Actual Behavior

Cloudflare pages reverts to the /index.html
because /functions is used for Cloudflare-specific stuff.

Steps to reproduce the bug

  1. Deploy any typedoc output to Cloudflare pages.
  2. Click any function on any of the docs pages.

Example:

I have this output:

Permissions Size User Date Modified Name .rw-rw-r-- 143 nullvoxpopuli 8 Dec 13:23 .nojekyll drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 assets drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 classes drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 functions .rw-rw-r-- 23k nullvoxpopuli 8 Dec 13:23 index.html drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 interfaces drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 modules .rw-rw-r-- 9.1k nullvoxpopuli 8 Dec 13:23 modules.html drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 types drwxrwxr-x - nullvoxpopuli 8 Dec 13:23 variables 

Which is deployed to: ember-resources.pages.dev/
On any page, such as: https://ember-resources.pages.dev/modules/util_cell
I click the available functions, such as: https://ember-resources.pages.dev/functions/util_cell.cell.html, but I am redirected to a poorly rendered version of https://ember-resources.pages.dev

My config:

{ "tsconfig": "../ember-resources/tsconfig.json", "entryPoints": [ "../ember-resources/src/index.ts", "../ember-resources/src/util/" ], "entryPointStrategy": "expand", "readme": "../README.md", "exclude": [], "json": "./docs.json", "out": "dist", "pretty": true, "excludePrivate": true, "excludeProtected": false, "excludeExternals": true, "disableSources": true, "searchInComments": true, "categorizeByGroup": false, "plugin": [ ] } 

Environment

typedoc 0.23.14 typescript 4.8.3 ❯ node -v v16.15.1 ❯ lsb_release -a No LSB modules are available. Distributor ID:	Ubuntu Description:	Ubuntu 22.04.1 LTS Release:	22.04 Codename:	jammy 

I guess, what I'd like to see is a way to have customization over the file/folder structure.
Maybe functions can be nested under their modules?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions