Skip to content

MkDocs build CI Job

Add a build job, that when included and a mkdocs.yml file is found in the repo it will build the static pages.

The job needs a flag to include the source files. Default will be false, but if MKDOCS_SOURCE_DIR variable exists, they will be copied to artifacts/{repo_name}/$MKDOCS_SOURCE_DIR

Default artifacts will be the build directory. The variable MKDOCS_BUILD_DIR will need to be set.

  • use package.json and then npm --prefix /path/where package/is install run will install the packages
"dependencies": {    
  "Package_name": "version_number"
}

🔗 References

Tasks

  • markdown linting will be required
Edited by Jon
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information