Uploaded image for project: 'eZ Publish / Platform'
  1. eZ Publish / Platform
  2. EZP-26944

Choose static-site generator for Github-based doc

    XMLWordPrintable

Details

    • Icon: Task Task
    • Resolution: Done
    • Icon: High High
    • None
    • None
    • Documentation

    Description

      Investigate available static-site generators for generating doc out of GitHub, identify pros and cons of each and choose the preferred one.

      Features requested

      Opensource tool

      It's politic statement here

      Links

      • Outside links
      • Links between pages

      Image insertion

      It's basically a link, but we would like the rendering of the image in <img> tag
      CSS classes to add to a content : usage of icons

      Table of Contents (TOC)

      • Having an option to configure generated TOC on each page
      • Placeholder to insert a TOC in a page only

      Syntax highlighting

      For the code parts

      Be able to indicate which code language is used

      • PHP, YAML, Javascript, Linux commands (Bash) are mandatory
      • HTML, CSS, XML are wanted

      PDF export

      • Single page export
      • Chapter export
      • All-the-doc export as a book

      Version software management / Language management

      To be able to insert a menu to switch between different versions/languages

      Nice to have

      Other formats export

      • HTML: a file for a page (save as... in the browser does that)
      • HTML in a single page per chapter
        ePub

      Tags/label as metadata

      To link pages or build chapter/booklets, having some system that manages tags

      Attachments

        Activity

          People

            Unassigned Unassigned
            dominika.kurek-obsolete@ibexa.co Dominika Kurek
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: