后台無法使用 mkdocs 為現有組件創建技術文檔

Question

我已啟用 Github 操作以在提交后創建技術文檔。 下面是為創建 Md 文件而編寫的工作流文件。 但是“techdocs-cli generate --no-docker --verbose”命令失敗並出現以下錯誤。 有人可以幫忙解決這個問題嗎？

無法從 /home/runner/work/myapp3/myapp3 生成文檔到 /home/runner/work/myapp3/myapp3/site； 由未知錯誤引起 'Command mkdocs failed, exit code: 1'

工作流文件：

name: Publish TechDocs Site
on:
 push:
 branches: master

jobs:
 publish-techdocs-site:
  runs-on: ubuntu-latest
  env:
  TECHDOCS_S3_BUCKET_NAME: XXX
  AWS_ACCESS_KEY_ID: XXX
  AWS_SECRET_ACCESS_KEY: XXX
  AWS_REGION:  XXX
  ENTITY_NAMESPACE: 'default'
  ENTITY_KIND: 'Component'
  ENTITY_NAME: ‘XXX’

steps:
  - name: Checkout code
    uses: actions/checkout@v2

  - uses: actions/setup-node@v2
  - uses: actions/setup-python@v2

  - name: Install techdocs-cli
    run: sudo npm install -g @techdocs/cli

  - name: Install mkdocs and mkdocs plugins
    run: python -m pip install mkdocs-techdocs-core==1.*

  - name: Generate docs site
    run: techdocs-cli generate --no-docker --verbose

  - name: Publish docs site
    run: techdocs-cli publish --publisher-type awsS3 --storage-name $TECHDOCS_S3_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME

Answer 1

我有同樣的問題，一旦你有正確的文件夾結構，你有mkdocs.yml文件，它就解決了。

只要你有一個與需要發布的.md file位於同一根結構中的docs文件夾。

mkdocs.yml文件的導航部分也需要配置相同的.md file