Github 在 README.md 中包含 md 文件？

Question

Github中有沒有辦法在例如 README.md 中包含 md 文件？

# Headline

Text

[include](File:load_another_md_file_here.md)

它不應該鏈接到文件，它應該從中加載內容，例如 PHP 包含/file_get_contents。

Answer 1

這似乎是不可能的，尤其是在考慮github/markup#346和github/markup#172時。

不支持包含指令。

Answer 2

這不是正確的答案，而是真正想要這個的其他人的解決方法。

在將文件發送到 Github 之前，可以使用Gulp和Gulp Concat將文件合並為一個。

Answer 3

由於不可能，我只是最終將鏈接放置為

[MY-LINK](../../SOME-OTHER-README.MD)

Answer 4

Ruby gem markdown_helper實現了 GitHub 風格的降價 (GFM) 的包含文件。

披露：我寫了寶石。

Answer 5

將您的自述文件遷移到不同的文件，然后構建您的實際自述文件，但是您喜歡將其作為 github 操作

編輯：這是一個可以構建的演示。 這個 repo 有一個 github 操作，它運行一個腳本，該腳本根據存儲庫的內容動態構建 README.md（以目錄的形式為 repo 構建站點地圖）： https://github。 com/dmarx/bench-warmers

工作流配置：

name: update-readme

on:
  push:
    branches: [ "main" ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v2
      - name: Run the script
        run: python scripts/update_readme.py
      - name: Commit files
        run: |
          git config --local user.name "dmarx"
          git add README.md
          git commit -m "Updated TOC"
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          force: true

這是與您相關的更新腳本的一部分：

... # code that builds the object `toc_str`

# template readme
with open('README.stub') as f:
    readme_stub = f.read()

# simple replacement, use whatever stand-in value is useful for you.
readme = readme_stub.replace('{TOC}',toc_str)

with open('README.md','w') as f:
    f.write(readme)

假設您有一個名為README.stub的文件，它可能看起來像這樣：

# Title

some text

{TOC}

more text

其中{TOC}是我們動態內容的替換目標。