jazzy
jazzy copied to clipboard
Generate a file where all documented symbols are listed (documented.json)
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.
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.
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.

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.
that means you are using file:/// urls and have not disabled local file restrictions
Thanks. Since I push the documentation (html tree) to our server, what changes are needed during Jazzy build ?
no changes are needed - have you tried the search on a server yet?
yes. Nothing happens when I enter the text in the search box.
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
the documentation is on a server under https. Is that a problem ? If so what changes are required on the server side ?
no, https is fine
Thanks for the support. will check internally if there are any restrictions on js.