Я не уверен, возможно ли это, но вот что я хотел бы сделать:
Я хотел бы создать грамотную программу , размещенную на github,и чтобы полученная в результате дружественная человеку литература автоматически публиковалась на странице проекта моего github.Под «автоматически публикуемым» я подразумеваю, что я могу запустить скрипт на своем локальном компьютере, который заканчивается «git push origin master» и заканчивается опубликованным дружественным для человека, содержащим математику документом на github.Я открыт для компромиссов по процедуре, чтобы добраться туда, но чем проще, тем лучше.
Многие люди не знают, что такое грамотное программирование, поэтому я подведу итог.Это система, в которой вы пишете один документ, который можно перевести как в исходный код, так и в удобный для человека документ.Цель состоит в том, чтобы очень четко объяснить алгоритм на английском (или другом естественном языке), и это считается полезным, когда пользователи могут быть заинтересованы в чтении вашего алгоритма так же, как и в его непосредственном использовании.Некоторые люди (например, Дональд Кнут) считают грамотное программирование критически важным инструментом при создании любого сложного программного обеспечения.
Одна из идей сделать это - создать что-то вроде файла README.md в качестве выходных данных грамотного пользователя.программа, но я не знаю никакой математической поддержки в форматировании github.Похоже, что вики github могут поддерживать некоторую математику, но я не знаю, как заставить вики генерироваться из кода - например, я хотел бы иметь возможность сделать git push origin master с моей машины, и иметьgithub wiki автоматически обновляется.
(Кроме того, чтобы понять, почему поддержка математики важна: я пришел из мира, где всегда пишут статьи с помощью TeX или LaTeX, и мне интересна общая система, котораядругие авторы, которые раньше использовали LaTeX, тоже могли бы его использовать.)
Есть идеи, как этого добиться?