-
-
Notifications
You must be signed in to change notification settings - Fork 231
Switch from mkdocs-material to zensical #1311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for pihole-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
I'm not sure if these options are available on the new system, but do we need them?
The new search window is a little different, but it also shows all results in real time while you type the search string, like mkdocs search. Not sure if the suggestions are needed. |
|
The whole search was completely re-implemented. We probably don't need Note: I removed |
Not sure if we really need this.
Can you provide a screenshot using the "classic" theme? |
It depends if they implement warning about files not included in the navigation. Tracking here: zensical/zensical#124
This is 1:1 the current Materials for MkDocs theme we use. So all screenshots are at https://docs.pi-hole.net/ |
i vote modern. (though i'm sure my vote doesnt count much😂😂) |
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
…e outside of `docs` which we should also consider Signed-off-by: yubiuser <[email protected]>
Signed-off-by: yubiuser <[email protected]>
What does this PR aim to accomplish?:
mkdocs-materialis in maintenance mode and their creators build a new site generation tool calledzensical(here). It offers a back-wards compatibility tomkdocs-materialso the transition is quite smooth.This is work in progress
Internal
markdown_includewithsnippetsas the former did not work well with zensical (adapts Add deprecation notice to OpenVPN pages [v6] #1029)zensical.tomlclassicvsmodern)External
git-revision-date-localized-pluginis still needed, Trackersearch.suggestandsearch.share--strictis missing, affecting link validationnot_in_nav, TrackerBy submitting this pull request, I confirm the following:
git rebase)