后台无法使用mkdocs为现有组件创建技术文档

Question

在提交之后，我已经启用了Github操作来创建技术文档。下面是为创建Md文件而编写的工作流文件。但是，“techdocs生成-不停靠-详细”命令失败了，出现了以下错误。有人能帮忙解决这个问题吗？

未能从/home/runner/work/myapp3 3/myapp3 3生成文档到/home/runner/work/myapp3 3/myapp3 3/site；原因是未知错误‘命令mkdocs失败，退出代码: 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文件就被解决了。

只要docs文件夹与需要发布的.md file位于同一个根结构中。

同样的.md file也需要在mkdocs.yml文件的导航部分进行配置。