LINUX.ORG.RU

Github как онлайн Desktop Publishing платформа: Markdown + Pandoc + Travis CI = PDF (и/или LaTeX)

 , ,


8

4

TL;DR

Автоматическая генерация (.md -> .pdf) и публикация документации на Github'е средствами Travis CI

1) Создаем документ или книгу в формате Markdown в виде репозитария на Github, например:
>>> https://github.com/mikepan/GameEngineBook

2) Настраиваем Travis CI для автогенерации PDF (оформляем .travis.yml, и т.д.) и выгрузки полученного PDF обратно в репозиторий на Github

P.S.: MikTeX или TeXLive возможно будет нужен при конвертировании в PDF для Pandoc под Linux

ЛИТЕРАТУРА:

★★★★★

Последнее исправление: atsym (всего исправлений: 17)

Github как издевательская система

нужные ещё юнит тесты перед сборкой и интеграционные тесты после.

system-root ★★★★★
()
Ответ на: комментарий от ptah_alexs

У меня будет свой Gitbook без ограничений и с автовыгрузками

Есть же gitbook.

Он же урезанный много в чём

Open Source
Ideal for public and open source projects.
Free
Unlimited public books
Unlimited visits and updates
5 collaborators
0 private books
Custom domains
Community Support

https://www.gitbook.com/pricing

Q: Is there a limit to the size of my book's content?

A: Yes, Both public and private books cumulated content size is limited to 256MB .
Currently, the Editor doesn't allow the upload of files larger than 10MB.

https://help.gitbook.com/content/is-there-a-limited-size.html

И там таких 'малозаметных' ограничений очень много

https://help.gitbook.com

atsym ★★★★★
() автор топика
Последнее исправление: atsym (всего исправлений: 3)

издательськая система: Markdown

Тогда лучше asciidoc. «Тот же markdown», только более заточенный под издательские штуки. Markdown, всё же, слишком беден. И pandoc поддерживает asciidoc. Последний только слишком мало распространён, но для самостоятельной работы это не особо принципиально.

KRoN73 ★★★★★
()
Ответ на: комментарий от KRoN73

AsciiDoc + Docker + Travis CI = PDF

http://mgreau.com/posts/2016/03/28/asciidoc-to-gh-pages-with-travis-ci-docker...

https://github.com/mgreau/asciidoc-to-ghpages

P.S.: Лично мне синтаксис AsciiDoc как-то не очень...

http://asciidoc.org/asciidoc.txt

... лучше тогда уж сразу на LaTeX писать, чем учить AsciiDoc, ИМХО.

atsym ★★★★★
() автор топика
Последнее исправление: atsym (всего исправлений: 2)
Ответ на: AsciiDoc + Docker + Travis CI = PDF от atsym

Лично мне синтаксис AsciiDoc как-то не очень...

По-моему, тот же Markdown, вид сбоку :)

лучше тогда уж сразу на LaTeX писать

«Лучше сразу на Си писать, чем изучать Python» ;) Это, всё же, довольно разные категории.

KRoN73 ★★★★★
()
Ответ на: комментарий от KRoN73

«Лучше сразу на Си писать, чем изучать Python»

Очень даже правда. А насчет латеха, так технарям без него — как без рук! Это фаллософы могут в бреду даже в виде cat > my_best_book.txt «труды» писать!

anonymous
()
Ответ на: комментарий от Norgat

«А чтобы было» ©

Делать кому-то нечего, вот и все.

Для написания книг есть только одна кошерная связка: latex + git, больше ничего удобного нет. А markdown — это ж вообще посмешище! Поди-ка, повтыкай в книжку таблицы, рисунки, формулы и предметный указатель в markdown...

anonymous
()

Настраиваем Travis CI для автогенерации PDF (оформляем .travis.yml, и т.д.) и выгрузки полученного PDF обратно в репозиторий на Github

о, да ты походу близок к тому, чтобы не клянчить билды на новые ветки и фичи, а самостоятельно их собирать

EvilSpirit
()
Ответ на: комментарий от EvilSpirit

близок

Не то чтобы уж совсем «близок», но потихоньку движусь в этом направлении

Уже удачно настроил автосборку AppImage для AzPainter

https://github.com/Symbian9/azpainter/issues/17

И хотелось бы и для SolveSpace иметь официальные сборки в виде AppImage, вроде даже с @probonopd нашли способ как настроить .travis.yml для сборки релиза SolveSpace 2.3 (с поддержкой сборки на платформах начиная с Trusty 14.04 LTS)...

... но, как всегда, «Баба Яга против!» (aka «Кац предлагает сдаться!»)

https://github.com/solvespace/solvespace/issues/17#issuecomment-336492346

atsym ★★★★★
() автор топика

Обмазался несвободными сервисами и радуется как дитя.

anonymous
()
20 декабря 2017 г.
31 марта 2018 г.
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.