Как я могу использовать файл PDF в качестве файла чтения в моем репозитории github?

У меня есть файл PDF, сгенерированный латексом, в котором много уравнений, а что нет. Я хочу использовать этот pdf-файл в качестве файла readme.md в моем репозитории github. Как я могу это сделать?

В качестве альтернативы можно ли напрямую интегрировать текстовый файл в github и использовать его в качестве файла чтения вместо версии в формате PDF? Разрешает ли github какую-либо интеграцию с латексным синтаксисом, как, например, gmail?


person JRun    schedule 15.06.2016    source источник
comment
Вы можете преобразовать его в изображения и поместить их в README.md, хотя это не очень элегантно. Должно быть лучше просто преобразовать части уравнений.   -  person Rogério Peixoto    schedule 15.06.2016
comment
Проверьте это: webapps.stackexchange.com/questions/48061/   -  person evan.oman    schedule 17.06.2016
comment
Если бы я посещал проект со сложной (и, возможно, обширной) документацией, я бы не хотел, чтобы сложная документация отображалась в области README. Вместо этого я предлагаю вам просто обобщить свой проект в файле readme и предоставить достаточно подробностей для компиляции, настройки, запуска или чего-то еще необходимого. Затем предоставьте PDF (который лучше читать) как отдельную загрузку. Я также не хотел бы, чтобы мой браузер загружал и отображал сложный PDF-файл, а использовал свою любимую программу просмотра PDF-файлов.   -  person Martin Nyolt    schedule 15.08.2016
comment
Я думаю, то, что вы хотите, на самом деле не выполнимо. Readme.md — это просто уценка. Вместо этого постарайтесь максимально преобразовать его в уценку (но см. -readme-in-my-github-repo#comment65266615_37826259">предыдущий комментарий) и ссылку на PDF.   -  person Martin Nyolt    schedule 15.08.2016
comment
Я вижу, что вы имеете в виду в своем первом комментарии. Ты прав; Я согласен.   -  person JRun    schedule 17.08.2016
comment
Я использовал уравнение в вики. Хак заключался в том, чтобы создать для него внешние образы. Я использовал mathurl.com для создания PNG на лету. Затем вы можете поместить их в файл readme.md в качестве внешнего образа. Пример здесь: github.com/scholi/pySPM/wiki/Mass-калибровка   -  person scholi    schedule 21.06.2018


Ответы (1)


Вы не можете импортировать PDF как Readme, но я также не вижу в этом смысла, поскольку он поддерживает замечательный язык MD, который можно легко увидеть на любом устройстве (в том числе мобильном).

Я исправил проблему с уравнениями, используя изображения. Для этого есть хороший веб-сайт: http://mathurl.com/.

Просто введите латексное уравнение и нажмите «Создать математический URL» (нижняя левая кнопка), скопируйте и вставьте ссылку на изображение (выделено красным).

Я использовал его в вики на github (но он должен работать так же и с readme.md): >https://github.com/scholi/pySPM/wiki/Массовая калибровка

Наслаждаться!

person scholi    schedule 09.07.2018
comment
Дело в том, что у меня есть docx с картинками, и преобразование в уценку просто не работает. тратить слишком много времени и потерпеть неудачу - person Gulzar; 23.03.2020
comment
Затем, возможно, сделайте свой документ как уценку и потом преобразуйте уценку в docx. Пользователи действительно ценят тот факт, что они могут видеть файл readme, не открывая документ, особенно docx, который может содержать вирусы. - person scholi; 23.03.2020
comment
Файлы уценки githubs не поддерживают библиотеки уравнений, такие как KaTex. - person Jonas Grønbek; 25.05.2020