NgDocPage

The page category

Any custom data that you can provide for the page and use on it via NgDocPage.data

The page demo components should be on object where key it's the component's class name and value it's class constructor

By default, a child route of a page opens as a standalone page: only the routed component, on the canvas of demos, with a link back to the page, without the navbar, the sidebar or the page. Set disableFullscreenRoutes to true to handle them yourself with a . It can be used for example in a demo that requires to show nested routes. Be careful however, only 1 router-outlet is allowed level, that can lead to collisions if multiple demos on the same page require nested routes.

If true the page will be hidden from the sidebar

Import Angular dependencies for the page. If you are using standalone components for demos and playgrounds, you don't need to import anything.

Path to the page markdown file

Build tags this page is rendered for. The page is part of a build only when the build has at least one of these tags; otherwise it has no route, navigation item, search entry or keyword, as if it did not exist. A page without onlyForTags is part of every build.

With the new generator engine (the Vite plugin, the vite-* builders and the ng-doc CLI), the build tags are:

• Vite plugin and vite-* builders: the Vite mode (development for the dev server, production for a build, or the builders' mode option), or generator.discovery.tags;
• ng-doc CLI: production for generate, development for dev and watch, or --tags.

null or an empty string means no filter; an empty array hides the entry in every build. The legacy application/dev-server builders ignore this option.

Order is using for sorting entities in the sidebar

The page playgrounds should be on object where key it's the playground's name and value its playground configuration

List of providers for the page they will be available for all components on the page

The route of the entity (current sourceFileFolder name by default)

The entity title