-
Notifications
You must be signed in to change notification settings - Fork 486
Switch to Duckquill for documentation #1565
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
Conversation
|
Thanks @daudix is there a way to keep the sending the repo docs in |
253bd13 to
b831850
Compare
|
I understand your concerns, the content can't be directly under the |
got it thanks maybe we can have |
c47482a to
5d23abd
Compare
89luca89
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@daudix can we do the reverse?
right now ./docs is a link to ./site/content, can we do so that ./site/content is the link to docs?
so that docs are kept where they are
5e23d83 to
1ae7788
Compare
|
Thanks @daudix Right now we miss the navigation (toc) due to not using pure markdown but some custom code like: this is kind of a deal breaker for me, I really value the docs on gh/gl pages and this makes them hard to follow read and search |
|
Yeah that's fair. Current docs work well enough and generate from vanilla markdown, and display properly right on GitHub. Sorry for wasting your time. |
|
Thanks to you, and the big effort you made |
It's been a while since #784, in which I've created my own Zola theme.
Demo is available on daudix.github.io/distrobox.
The main differences are that all Markdown files now live under the
contentdirectory, all layouts and styling is now managed by Duckquill submodule, which means easy updates, and of course the looks, copy button for code blocks, cross-site search, and other QoL improvements :DIn terms of syntax everything is pretty similar to Jekyll, the link syntax is different though, which means they don't work without building the site.
Since GitHub Pages automatically build only Jekyll sites, I've added a new workflow that builds the site to the
gh-pagesbranch on every new commit in thereleasebranch, and tests the build on pull requests. GitHub Pages source will need to be changed to thegh-pagesbranch.