vespa icon indicating copy to clipboard operation
vespa copied to clipboard

docs.vespa.ai as single-page html or pdf

Open kkraune opened this issue 4 years ago • 8 comments

... to make it easier to read Vespa documentation on an e-reader / offline

Vespa documentation is generated using Jekyll from .md and .html files, look into options for generating the artifact as part of site generation (there might be plugins we can use here)

kkraune avatar Apr 02 '21 09:04 kkraune

Hey @kkraune I don't know for sure but this https://github.com/JCB-K/singlepage-jekyll might be what you are looking for.

IMPranshu avatar Jan 19 '22 08:01 IMPranshu

Thanks, will look into!

kkraune avatar Jan 19 '22 09:01 kkraune

I am looking for contributing. I am a beginner. Would be happy to be a part of solving this.

IMPranshu avatar Jan 19 '22 10:01 IMPranshu

All right! All the documents are found in https://github.com/vespa-engine/documentation/blob/master/_data/sidebar.yml - this is used to build the sidebar and table of contents. I assume this is a useful starting point for generating the pdf with the right content.

kkraune avatar Jan 19 '22 11:01 kkraune

Thanks, sir, I am on it. Will keep u updated.

IMPranshu avatar Jan 19 '22 11:01 IMPranshu