Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
honzajavorek opened this issue Aug 8, 2016 · 1 comment
Open

Comments

@honzajavorek
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant