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

Offline documentation #282

Closed
Xianguang-Zhou opened this issue Jul 3, 2017 · 5 comments
Closed

Offline documentation #282

Xianguang-Zhou opened this issue Jul 3, 2017 · 5 comments
Milestone

Comments

@Xianguang-Zhou
Copy link

Is there a PDF or EPUB documentation for offline reading?

@ebussieres
Copy link
Member

ebussieres commented Nov 4, 2018

@cjbrooks12 @bjansen Is it something we can do with Orchid ?

@cjbrooks12
Copy link
Contributor

It's not currently supported, though it should be relatively easy to implement, if there's good Java libraries to convert HTML to PDF/EPUB.

The wiki plugin was directly inspired by GitBook so conversion to PDF is an idea I've wanted to have in Orchid for a long time, and I'd be happy to implement it. But I've never done any HTML->PDF conversion in Java and I don't really know where to start, so I would appreciate any help if you have suggestions for libraries or anything like that.

@bjansen
Copy link
Contributor

bjansen commented Nov 5, 2018

I believe an offline HTML documentation would be easy, though.

@cjbrooks12
Copy link
Contributor

I've gotten Orchid generating the wiki contents as a PDF! This will be available in the next major release, and I'll make the necessary changes here to support it when it's released.

@ebussieres
Copy link
Member

Great news !

cjbrooks12 added a commit to cjbrooks12/pebble that referenced this issue Mar 11, 2019
@ebussieres ebussieres added this to the 3.0.9 milestone Apr 10, 2019
ebussieres pushed a commit that referenced this issue Apr 15, 2019
* Updates Orchid version, generates offline documentation from Wiki pages. Closes #282

* Adds Embed tag

* Adds lots more tests, and test notes

* Adds tests for error-handling, and updates docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants