Блог

Я не уверен, возможно ли это, но это то, что я хотел бы сделать:

Я хотел бы создать грамотную программу, размещенную на github, и чтобы полученная в результате понятная для пользователя литература автоматически публиковалась на странице проекта моего github. Под «автоматически публикуемым» я подразумеваю, что я могу запустить скрипт на своем локальном компьютере, который заканчивается на «git push origin master» и в итоге публикует удобный для пользователя документ, содержащий математику, на github. Я открыт для компромиссов в процедуре, чтобы добраться туда, но чем проще, тем лучше.

Многие люди не знают, что такое грамотное программирование, поэтому я подведу итог. Это система, в которой вы пишете единый документ, который может быть переведен либо в исходный код, либо в документ, понятный пользователю. Цель состоит в том, чтобы очень четко объяснить алгоритм на английском (или другом естественном языке), и это считается полезным, когда пользователям может быть так же интересно прочитать о вашем алгоритме, как и использовать его напрямую. Некоторые люди (например, Дональд Кнут) считают грамотное программирование важнейшим инструментом при создании любого сложного программного обеспечения.

Одной из идей для этого было бы сгенерировать что-то вроде README.md файл в качестве выходных данных грамотной программы, но я не знаю о какой-либо математической поддержке в форматировании markdown в github. Похоже, что вики-страницы github могут поддерживать некоторую математику, но я не знаю, как заставить wiki генерироваться из кода — например, я хотел бы иметь возможность выполнять git push origin master со своего компьютера и автоматически обновлять github wiki.

(Также, чтобы понять, почему важна поддержка математики: я родом из мира постоянного использования TeX или LaTeX для написания статей, и меня интересует общая система, которую могли бы использовать и другие авторы, привыкшие к LaTeX.)

Есть идеи, как этого добиться?

Вики поддерживаются собственным репозиторием git, поэтому вы можете нажать на него и автоматически обновить. Хотя это другой репозиторий, чем основной. Насколько я знаю, этот материал поддерживается только в вики, а не в главном процессоре уценки репозитория.