Программное обеспечение для форматирования / веб-публикации учебного типа, технические статьи
Я хочу разместить некоторые из моих собственных технических статей в Интернете: учебные пособия, практические рекомендации, концептуальные статьи о программировании и т. Д. Я пишу в основном для себя, но думаю, что другие могут извлечь из этого пользу, поэтому я хочу выложить его в Интернете, и я также есть планы сделать все более связным и превратить его в книгу.
Мои статьи не предназначены для блога, они просто представляют собой набор учебников и практических рекомендаций, но я думаю, что программное обеспечение типа блога, вероятно, будет наиболее подходящим способом форматирования такого рода вещей.
Прямо сейчас я использую функцию блога cite u like, которая очень низкотехнологична, и мне действительно нужно что-то лучшее. В моем списке пожеланий, среди прочего:
- фрагменты кода в прокручиваемых полях
- подсветка синтаксиса для фрагментов исходного кода
- теги статей с графическими значками в соответствии с темой, как в slashdot
- конечно пользователи (то есть читатели) должны иметь возможность комментировать статьи
- Кроме того, просто больше вариантов, чем супер-простой блог
- должно выглядеть гладко! не должен выглядеть как википедия
Есть ли какое-либо программное обеспечение, которое вы можете порекомендовать для этой цели?
3 ответа
Для технической документации онлайн, как насчет чего-то вроде http://sphinx/ например?
Это не самый популярный выбор, но мне очень нравятся ikiwiki (от Joey Hess из Debian Fame). Это система, написанная на Perl, которая по умолчанию компилирует страницы Markdown в статические HTML-файлы. Его шаблоны блога работают для того, что вы хотите сделать.
Прежде всего, эта система очень гибкая и способна делать все, что угодно, по самой своей конструкции. С помощью базового Perl можно легко и быстро создавать собственные плагины.
Вся система построена на системах контроля версий, например, Git. Сайт перестраивается (ну, в любом случае, релевантные части), когда контент фиксируется, что дает контроль версий как встроенную функцию.
Это дает вам систему комментариев, используя OpenID для идентификации. Вы можете легко встроить код с подсветкой исходного кода (желательно) библиотекой Perl для выделения. Код помещается в прокручиваемые блоки, а также может быть свернут (я использую эту функцию).
В его конфигурации по умолчанию это выглядит довольно неприятно, на мой взгляд, но каждый аспект может быть изменен с помощью локального файла CSS.
Я очень доволен этим, по крайней мере. То, что он тесно связан с Git/Mercurial/ чем-то, что для меня является убийственной функцией, и поскольку каждый аспект самого сайта может быть изменен с помощью шаблонов, он более или менее бесконечно гибок.