paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 14 Packages Projects Releases Wiki Activity

Updated default name and params

Browse Source 
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
This commit is contained in:
Andre Wanlin
2023-01-10 14:16:53 -06:00
committed by Renan Mendes Carvalho
parent 591dc81ff8
commit c9758fe81e
3 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-node/src/stages/generate/helpers.ts
+6 -7
View File
@@ -154,8 +154,8 @@ export const MKDOCS_SCHEMA = DEFAULT_SCHEMA.extend([
* Generates a mkdocs.yml configuration file
*
* @param inputDir - base dir to where the mkdocs.yml file will be created
* @param siteName - name of site to be used in mkdocs.yml for the
* required `site_name` property, default value is "Table of Contents"
* @param siteOptions - options for the site: `name` property will be used in mkdocs.yml for the
* required `site_name` property, default value is "Documentation Site"
*/
export const generateMkdocsYml = async (
inputDir: string,
@@ -168,7 +168,7 @@ export const generateMkdocsYml = async (
// minimum mkdocs.yml file
const mkdocsYmlPath = path.join(inputDir, 'mkdocs.yml');
const defaultSiteName = siteOptions?.name ?? 'Table of Contents';
const defaultSiteName = siteOptions?.name ?? 'Documentation Site';
const defaultMkdocsContent =
`site_name: ${defaultSiteName}\n` +
'docs_dir: docs\n' +
@@ -186,10 +186,9 @@ export const generateMkdocsYml = async (
* depending on which is present (MkDocs supports both as of v1.2.2).
* @public
*
* @param inputDir - base dir to be searched for either an mkdocs.yml or
* mkdocs.yaml file.
* @param siteName - name of site to be used in mkdocs.yml for the
* required `site_name` property, default value is "Table of Contents"
* @param inputDir - base dir to be searched for either an mkdocs.yml or mkdocs.yaml file.
* @param siteOptions - options for the site: `name` property will be used in mkdocs.yml for the
* required `site_name` property, default value is "Documentation Site"
*/
export const getMkdocsYml = async (
inputDir: string,
plugins/techdocs-node/src/stages/generate/types.ts
+1 -1
View File
@@ -53,7 +53,7 @@ export type GeneratorConfig = {
* @param etag - A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.
* @param logger - A logger that forwards the messages to the caller to be displayed outside of the backend.
* @param logStream - A log stream that can send raw log messages to the caller to be displayed outside of the backend.
* @param siteName - Name of the site to be used in mkdocs.yml for the required `site_name` property, default value is "Table of Contents"
* @param siteOptions - Options for the site: The `name` property will be used in mkdocs.yml config for the required `site_name` property, default value is "Documentation Site"
*/
export type GeneratorRunOptions = {
inputDir: string;