-
Notifications
You must be signed in to change notification settings - Fork 2
Template URIs JSON Format
The following formats is the format for creating a JSON file that contains all the file locations to the EJS files used by the action that templates the documentation web pages together. This is used to create your own template and ultimately change how the final web page gets rendered. Excluding any of these field will make the action use the premade template's file location instead. The premade template is provided by filling in the template input with the default template being the default. Note: If you are creating your own premade template, then excluding any of the fields will cause an error since, as a premade template, there is no backup file to use as a safety net.
This JSON format is used for members of a type, so that users can see a short-but-sweet view of the member and understand what it is with an anchor going to the fuller more detailed view of the member.
compact as (string): The file location to the compact partial view of the member of the type that contains the short-but-sweet description of the member.
full as (string): The file location to the full partial view of the member of the type that contains the full detailed description of the member.
This JSON format is used for gathering together all the EJS files split into different specific views to compile into a cohesive whole. Each partial view looks into different parts of the type.
includeDefaultCssas (boolean): Set to true to include the CSS files to be copied over by the premade template. Defaults to true by the action. This is so when generating, the action can customize the CSS of the template by stopping default files being copied over. If creating a premade template, then ignore this field.
includeDefaultScripts as (boolean): Set to true to include the JS files to be copied over by the premade template. Defaults to true by the action. This is so when generating, the action can customize the JS of the template by stopping default files being copied over. If creating a premade template, then ignore this field.
includeDefaultFiles as (boolean): Set to true to include any files to be copied over by the premade template. Defaults to true by the action. This is so when generating, the action can customize any files by stopping default files being copied over. If creating a premade template, then ignore this field.
localCss as (string[]): A list of CSS files to get copied over to the output path's CSS folder for local use.
localScripts as (string[]): A list of JS files to get copied over to the output path's JS folder for local use.
localFiles as (string[]): A list of any kind of files to be copied over to the output path's folder for local use. The folder name will be the name of the folder where the local file is originally located at.
globalCss as (string[]): A list of global CSS files to be referenced by the template.
globalScripts as (string[]): A list of global scripts to be referenced by the template.
base as (string): The base template that will host the header, type, namespace, and footer templates.
navigation as (string): The navigation template that will host the header and footer and will create a nested list view of the navigation.
header as (string): The header template that will generate the header portion of the web page.
footer as (string): The footer template that will generate the footer portion of the web page.
namespace as (string): The namespace template that will generate all the types found within the namespace. Should be generated on top of the base template.
type as (string): The type template that will generate all the information on the type. Should be generated on top of the base template.
constructors as (CompactFullUris): The constructor template that will generate the compact and full views of all the constructors of the type. Should be generated on top of the type template.
fields as (CompactFullUris): The field template that will generate all the compact and full views of all the fields of the type. Should be generated on top of the type template.
properties as (CompactFullUris): The property template that will generate all the compact and full views of all the properties of the type. Should be generated on top of the type template.
events as (CompactFullUris): The event template that will generate all the compact and full views of all the events of the type. Should be generated on top of the type template.
methods as (CompactFullUris): The method template that will generate all the compact and full views of all the methods and operators of the type. Should be generated on top of the type template.