mkdocs-filter-and-sort

[plbremer]

updated mkdocs.yaml and added .js files such that generated documentation has filter/sort capabilites for tables.

example:

[sujaypatil96]

@plbremer thank you for adding the functionality to sort and filter tables in the generated HTML docs/webpages, it's much appreciated!!

One thing that I'm skeptical about is putting the additional javascript files in the src/docs/ folder. I don't know if the intention for that folder is that it should contain only markdown, or if it's also okay to put in scripts that are required for building customized documentation.

Feel free to bring this discussion/topic to a LinkML developers call, or if you're unavailable during that time I can bring it up on the next call and let you know what the consensus is. I'll ask if it's okay to put the javascript files in src/docs/ or if people would prefer we make another new folder at the same level as docs/ called say scripts/ which can contain additional scripts that may or may not be limited to javascript (i.e., can include python and so forth as well) and have them be copied over into the destination documentation folder so that mkdocs can look for it.

We may or may not need to update to the gendoc Makefile target/rule here depending on what we decide: https://github.com/linkml/linkml-project-cookiecutter/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/Makefile#L195-L197

Another possible concern/caveat is that for some HTML tables we are displaying the contents of that table in a "hierarchially indented" fashion. For example, see this table: https://microbiomedata.github.io/nmdc-schema/#classes

Filtering is pretty straightforward but we haven't discussed how sorting should work on a table like this yet.

[cmungall]

how about https://squidfunk.github.io/mkdocs-material/reference/data-tables/#sortable-tables

[plbremer]

Hi Sujay/Chris,

1. If you could generate a response on my behalf for the /src/docs portion, that would be great.
2. I agree that the make gendoc command works as is, but might require reworking
3. @cmungall Indeed, I followed that guide to get the sorting working. Then, I roughly applied the same steps to get the filtering working using a different "javascript library".
   3 continued) Well, I guess I would defer to the maintainers of LinkML for how the indentation ought to work. One could imagine obsoleting the quandary by only permitting the filtering portion of this PR.

Please let me know your thoughts.

[noelmcloughlin]

Including extra javascript under src/docs/ is probably okay. Sandboxed environments cannot retrieve mermaid from internet for example: fralau/mkdocs-mermaid2-plugin#64 and make gendoc works without changing Makefile

[sujaypatil96]

Would it be too much work for you to split this out into two separate PRs @plbremer? The reason I ask is because I know we definitely want to have filtering on tables by default, but what I'm not super sure about is sorting, and that's because of the hierarchically indented table view that I mentioned in my above comment.

[plbremer]

Would it be too much work for you to split this out into two separate PRs @plbremer? The reason I ask is because I know we definitely want to have filtering on tables by default, but what I'm not super sure about is sorting, and that's because of the hierarchically indented table view that I mentioned in my above comment.

np
#104
#105