This component will produce a static HTML export of your Markdown files. The export can be either published to GitLab pages or released as web server container.

See a list of available configuration options.

Usage

Create a docusaurus.config.ts and sidebars.ts in folder docs
Optionally create a in folder docs
Create a multiple Markdown files in folder docs
Create GitLab pipeline file .gitlab-ci.yml:

include:
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
  inputs:
    proxy: true
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/workflow@stable
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/semantic-release@stable
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/lint-markdown@stable
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/docusaurus@stable

Inputs

Name	Description	Default	Type
---	---	---	---
dependencies	The dependencies that this job depends on.	[]	array
docusaurus-version	Version of Docusaurus to use	${DOCUSAURAUS_VERSION}	string
export-container-enabled	Export to registry container	false	boolean
name	Name of the documentation	documentation	string
needs	The jobs that this job depends on.	[]	array
path	Path to markdown files	docs	string
rules	Rules for the build job	[{"if":"$CI_PIPELINE_SOURCE == \"schedule\"","when":"never"},{"when":"on_success"}]	array
rules-release	Export to GitLab pages	[{"if":"$CI_PIPELINE_SOURCE == \"schedule\"","when":"never"},{"if":"$CI_COMMIT_TAG =~ $CI_PATTERN_SEMVER","when":"on_success"},{"when":"never"}]	array
stage	The pipeline stage that the jobs belongs to.	build	string
tags	The runners that this job depends on.	[]	array

Inputs​

Inputs