jazzy icon indicating copy to clipboard operation
jazzy copied to clipboard

Generate a file where all documented symbols are listed (documented.json)

Open erdnussflips opened this issue 5 years ago • 11 comments

It would be useful to generate a "documented.json" file parallel to the "undocumented.json" file, in which all symbols that are already documented are listed.

erdnussflips avatar Jul 19 '19 10:07 erdnussflips

Is there any way to do it, say using some other external tool ? I am trying to have live search within Jazzy search as mentioned here.. https://pspdfkit.com/blog/2016/adding-live-search-to-jazzy/ However, it needs a json having all the documented items. Alternatively, if there is a build param that I can use to have this enabled by default, I will be happy to do it. By not having --disable-search, I just see the search box. But it doesnt really do the search.

rashenoy avatar Mar 01 '21 04:03 rashenoy

Yes you could generate a documented.json file by processing the 'search.json'.

What do you mean it doesnt really do the search ? Search is in the apple and fullwidth theme.

Screenshot 2021-03-01 at 10 48 57

johnfairh avatar Mar 01 '21 10:03 johnfairh

Thanks for the update. I am using apple theme. When I type something in the search window it doesnt bring down the list like you have shown. If I hit enter, it just opens the search.json in the browser tab. Screenshot 2021-03-01 at 4 29 20 PM

rashenoy avatar Mar 01 '21 10:03 rashenoy

that means you are using file:/// urls and have not disabled local file restrictions

johnfairh avatar Mar 01 '21 11:03 johnfairh

Thanks. Since I push the documentation (html tree) to our server, what changes are needed during Jazzy build ?

rashenoy avatar Mar 01 '21 11:03 rashenoy

no changes are needed - have you tried the search on a server yet?

johnfairh avatar Mar 01 '21 11:03 johnfairh

yes. Nothing happens when I enter the text in the search box.

rashenoy avatar Mar 01 '21 11:03 rashenoy

if you're sure you've uploaded all the files and are definitely using an http[s] url to access it then you should open an issue with a demo -- given that the search works widely though, it is likely to be a configuration/browser issue

johnfairh avatar Mar 01 '21 11:03 johnfairh

the documentation is on a server under https. Is that a problem ? If so what changes are required on the server side ?

rashenoy avatar Mar 01 '21 11:03 rashenoy

no, https is fine

johnfairh avatar Mar 01 '21 11:03 johnfairh

Thanks for the support. will check internally if there are any restrictions on js.

rashenoy avatar Mar 01 '21 12:03 rashenoy