Generate a single page docs with index (TOC) as anchors

[nktnet1]

Hello,

I would like to generate a single page doc with a table of content (indices) at the top of the page.

When an index is clicked on, it takes the user to the relevant function of the page (e.g. using anchors).

How can this be done?

---

I've looked at the example at

• https://github.com/typedoc2md/typedoc-plugin-markdown-examples/tree/main/examples/single-page-docs

and "router": "module" is what I want in terms of concatenating everything to a single README.md, but doing so means no table of contents is generated.

---

My current config is:

{
  "$schema": "node_modules/typedoc-plugin-markdown/typedoc-plugin-markdown.schema.json",
  "plugin": ["typedoc-plugin-markdown"],
  "entryPoints": ["./src/index.ts"],
  "gitRevision": "main",
  "hidePageHeader": true,
  "out": "./docs",
  "readme": "assets/BASE.md",
  "enumMembersFormat": "table",
  "indexFormat": "table",
  "mergeReadme": true,
  "parametersFormat": "table",
  "router": "module",
  "typeDeclarationFormat": "table",
  "useCodeBlocks": true,
  "externalSymbolLinkMappings": {
    "typescript": {
      "Date": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date"
    }
  }
}

Project: https://github.com/nktnet1/date-fns-holidays

Thank you!

[tgreyuk]

Hello,

You can add a TOC from page headings using remark.

I have added an example to the examples repo here - https://github.com/typedoc2md/typedoc-plugin-markdown-examples/blob/main/examples/remark/docs/README.md

typedoc.json here - https://github.com/typedoc2md/typedoc-plugin-markdown-examples/blob/main/examples/remark/typedoc.json

I would give that a go as a first step.

[nktnet1]

It worked - thank you so much!