search

linkml / linkml-project-cookiecutter

A cookiecutter for linkml projects. An equivalent of `linkml-ws new project-name`.
Creative Commons Zero v1.0 Universal
14 stars 16 forks source link

mkdocs-filter-and-sort #99

Open plbremer opened 4 months ago

plbremer commented 4 months ago

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

example:

image
cmungall commented 4 months ago

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

plbremer commented 4 months ago

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 commented 4 months ago

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

sujaypatil96 commented 4 months ago

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 commented 3 months ago

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 https://github.com/linkml/linkml-project-cookiecutter/pull/104 https://github.com/linkml/linkml-project-cookiecutter/pull/105