Есть ли способ вложения содержимого файла (из репо проектов) в уценку Githubs?
У меня есть образец кода и вы хотите встроить его в файл readme.
Ответ 1
Вы не можете сделать это в настоящее время. Вам нужно будет скопировать образец кода и вставить его между тремя тиками в вашем файле README. Вот пример:
``` Ruby
class MyClass
end
```
Это будет, конечно, статическим, и вы должны обновить его вручную, когда этот код изменится.
Ответ 2
Ответ @Petros (все еще) правильный, однако меня это раздражало, и я создал инструмент для автоматизации копирования и синхронизации вашего readme с источником - https://github.com/zakhenry/embedme.
Пример использования из принятого ответа
Вставьте комментарий в коде забора
'''rb
# path/to/your/file.rb
'''
Запустите npx embedme README.md (предполагается, что у вас установлен Nodejs)
README будет написано на месте, с содержанием файла после вашего комментария
'''rb
# path/to/your/file.rb
class MyClass
end
'''
Обратите внимание, что, поскольку комментарий все еще там, вы можете снова запустить npx embedme README.md и он не внесет никаких изменений.
Если у вас есть CI, вы также можете запустить npx embedme --verify README.md который вернет 1 если обнаружит diff (это будет означать, что источник был обновлен без обновления readme).