https://github.com/prgfx/typedoc-pages-example-16

minimal example for a problem with [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages)
https://github.com/prgfx/typedoc-pages-example-16

Last synced: over 1 year ago
JSON representation

minimal example for a problem with [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages)

• Host: GitHub
• URL: https://github.com/prgfx/typedoc-pages-example-16
• Owner: PRGfx
• Created: 2021-02-26T09:56:02.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-26T09:57:01.000Z (over 5 years ago)
• Last Synced: 2025-01-20T07:14:36.759Z (over 1 year ago)
• Language: TypeScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
This repository is a minimal example for a problem with [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages).

## Setup

* `npm install`

* `npm run typedoc-pages`

Docs are built into `./docs-pages`

## Problem

* docs generated from code are usually grouped in a separate page-group

* when accessing a sub-module, the page-grouping breaks:

    * `/docs-pages/modules/two.html`:  

      ```

      markdown // example md page in this repo

        example

      API

        Modules

        one

        two // current

      {...module members}

      ```

    * `/docs-pages/modules/one.submodule.html`:  

      ```

      markdown

        example

        Modules // <-- wrongly grouped & no children*

      {...module members}

      ```

\* submodules removing the rest of the navigation occurs with typedoc only as well.

However there is no grouping of pages so the problem is not apparent.

Run `npm run typedoc-only` to build docs to `./docs` without pages plugin.