Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Relish is unusable for hosting documentation - find a replacement #21

@honzajavorek

Description

@honzajavorek

Relish has several flaws:

  • Publishing has to be manual, because the relish gem prompts for credentials interactively (maybe workaround exists?).
  • HTML rendered from correct Markdown often contains erroneous output (list items squashed, incorrect formatting of code as a link label, ...).
  • The generated ToC is sorted alphabetically instead of according to the contents of .nav. There is no way to sort them in a way useful for a reader.
  • There is no way to get a nice name for pure markdown files in ToC - e.g. add-implementation.md is displayed as Add-implementation in the ToC and on the page itself and there's no way to override it.

For that reason, if anyone knows how to efficiently document something together with gherkin scenarios e.g. in Sphinx, please let us know. We will gladly replace Relish with something else.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions