@ng-doc/builder
Version:
<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>
42 lines (41 loc) • 1.17 kB
TypeScript
import { SchematicArgv } from '../schematic-argv';
/**
* The interface describes the possible parameters for generating the page,
* the generator can be called by the command below 123
*
* ```bash
* ng g @ng-doc/builder:page
* ```
*
* Here is an example showing how you can call a generator with all parameters
*
* ```bash
* ng g @ng-doc/builder:page MyPage -r custom-route -m -c -o 1
* ```
*/
export interface NgDocBuildPageSchema extends SchematicArgv {
/**
* Title of the page (can be provided as string after command)
*/
title: string;
/**
* Name of the page variable (alias is `-n`, title in PascalCase by default)
*/
name?: string;
/**
* Custom route for the page (alias is `-r`, parent folder name by default)
*/
route?: string;
/**
* Order of the page in sidebar (alias is `-o`, NgDoc sorting pages by name by default)
*/
order?: number;
/**
* If parameter was provided, generator will import first parent category automatically (alias is `-c`)
*/
category?: boolean;
/**
* Keyword for the entity (alias is `-k`)
*/
keyword?: string;
}