Github включить MD файлы в README.md?

Question

Есть ли способ в Github включить MD файлы, например, в README.md?

# Headline

Text

[include](File:load_another_md_file_here.md)

Он не должен ссылаться на файл, он должен загружать содержимое из него, как PHP include / file_get_contents.

Answer 1

Это кажется невозможным, особенно если учесть github/markup#346 а также github/markup#172,

Директива включения не поддерживается.

Answer 2

Поскольку это невозможно, я просто разместил ссылку как

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

Answer 3

перенесите свой файл readme в другой файл, затем создайте свой фактический README, как вам нравится, как действие github

РЕДАКТИРОВАТЬ: Вот демонстрация, из которой вы можете построить. В этом репозитории есть одно действие github, которое запускает скрипт, который динамически создает README.md на основе содержимого репозитория (чтобы построить карту сайта для репозитория в виде оглавления): https://github .com/dmarx/бенч-грелки

конфигурация рабочего процесса:

      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}является целью замены для нашего динамического содержимого.

Answer 4

Это не правильный ответ, а обходной путь для тех, кто действительно этого хочет.

Можно использовать Gulp и Gulp Concat для объединения файлов в один, прежде чем они будут отправлены в Github.

Answer 5

Ruby gem markdown_helper включает в себя файлы для GitHub приправленной уценки (GFM).

Раскрытие: я написал драгоценный камень.