infrastructure/gitlab-ci
2
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Projects Releases 21 Wiki Activity

docs(mkdocs): Completed the mkdocs build readme

Browse Source 
fixes #15 !15
This commit is contained in:
Jon Lockwood
2022-01-23 11:07:47 +09:30
parent 6363ea377c
commit 1ef0e2245f
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
build/.gitlab-ci.yml
View File

@ -5,7 +5,6 @@
GIT_DEPTH: 0 GIT_DEPTH: 0
MKDOCS_VERSION: "==1.2.3" MKDOCS_VERSION: "==1.2.3"
MKDOCS_BUILD_PATH: build MKDOCS_BUILD_PATH: build
# MKDOCS_INCLUDE_SOURCE: "NO" optional to specify yes
MKDOCS_SOURCE_PATH: pages MKDOCS_SOURCE_PATH: pages
before_script: before_script:
- mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME" - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"

4
build/mkdocs.md
View File

@ -1,5 +1,5 @@
# MKDocs Static Site Build # MKDocs Static Site Build
Build a MKDocs site from the config specified in `mkdocs.yml`. _Only runs if `mkdocs.yml` exists in the repository root directory._ Build a MKDocs site from the config specified in `mkdocs.yml`. _Only runs if `mkdocs.yml` exists in the repository root directory._ This job is designated to run on all branchs so that you can use the artifacts for deployment to `staging` and/or `production` as required.
This job provides the following badge: This job provides the following badge:
@ -7,7 +7,7 @@ This job provides the following badge:
## Dependencies ## Dependencies
- _None_ - **Mandatory** file `mkdocs.yml` in the repository root directory with your MKDocs configuration
## your .gitlab-ci.yml changes ## your .gitlab-ci.yml changes
To use this job add the following to your `.gitlab-ci.yml` file To use this job add the following to your `.gitlab-ci.yml` file