home.social

#mdbook — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #mdbook, aggregated by home.social.

  1. #UANA community forums now provide a static DB dump in Markdown format: use /flarumdown URI to download in your network, e.g. http://[202:68d0:f0d5:b88d:1d1a:555e:2f6b:3148]/flarumdown/

    As a bonus, here’s an open-source CLI tool in #Rust for other #Flarum v2 users:
    github.com/YGGverse/flarumdown

    What is next? Maybe Git publishing after tests, then #mdBook wiki, based on at least this dump.

    #flarumdown

  2. Книга в Markdown: Автоматическая сборка статического сайта mdBook и файла DOCX с оформлением по ГОСТ

    Текст книг, учебных пособий, научно-технических статей, документации, дипломных и курсовых работ часто набирается и редактируется в WYSIWYG-редакторе, таком как Microsoft Word, в том числе вследствие того, что издательства и организации требуют от авторов оформленный по ГОСТ или внутренним стандартам docx-документ. Процесс работы в Microsoft Word и аналогичных редакторах не лишён недостатков: docx-файлы трудно версионировать в git, а для объединения нескольких документов в один придётся перенумеровывать источники, рисунки, таблицы, формулы. Альтернативой docx является LaTeX. Однако работа со стилями в LaTeX простотой и минималистичным синтаксисом не отличается , причём издательства от использования формата docx отказываться не торопятся. А инструменты в духе typst отличаются нестандартным синтаксисом языка для описания документов, причём возможность генерации сайтов в typst имеет пометку «in preview». Markdown — популярный и удобный язык разметки, но это также и очень ограниченный формат. Поэтому задача написания в Markdown сложной технической документации по ГОСТ, научной статьи с автоматической настройкой оформления для заданного издательства или хорошо оформленного онлайн-учебника может показаться неосуществимой. В этой статье рассмотрим способ работы над научно-техническими статьями и книгами в формате Markdown на основе подхода Docs as Code с учётом строгих ограничений на оформление, используемый Петром Советовым @true-grue и мной при подготовке учебных материалов в РТУ МИРЭА. Способ заключается в применении утилиты pandoc для построения дерева абстрактного синтаксиса (AST) Markdown-документа с последующим переписыванием AST набором фильтров на Lua и трансляцией AST в форматы docx и pdf, соответствующие ГОСТ, а также в диалект markdown, совместимый с mdBook , для генерации онлайн-учебника в виде статического сайта. Исходный код книги , написанной с использованием описанного в статье подхода, опубликован на GitHub.

    habr.com/ru/articles/987982/

    #pandoc #markdown #lua #python #документирование #гост #docx #graphviz #mdbook #github

  3. And its merged, with the 5.0.0 release #notify for #Rust will finally support #kqueue on #BSD 🎉

    Next step, after the 5.0.0 release is out, help projects using it to update to that version, so we get proper file system event goodness on BSD. #alacritty #rust-analyzer #cargo-watch #mdBook #cobalt

    #FreeBSD #OpenBSD #NetBSD #dragonflybsd