Skip to content
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

Switch to Duckquill for documentation #1565

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

daudix
Copy link
Contributor

@daudix daudix commented Sep 21, 2024

It's been a while since #784, in which I've created my own Zola theme.

Demo is available on daudix.github.io/distrobox.

Screenshot 2024-09-21 at 20-50-22 Home - Distrobox

The main differences are that all Markdown files now live under the content directory, 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 :D

In 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-pages branch on every new commit in the release branch, and tests the build on pull requests. GitHub Pages source will need to be changed to the gh-pages branch.

Screenshot From 2024-09-21 21-30-15

@daudix daudix changed the title Use Duckquill for docs Switch to Duckquill for documentation Sep 21, 2024
@89luca89
Copy link
Owner

Thanks @daudix is there a way to keep the doc directory as is?
the idea is that docs here, and website (and man pages too!) are all in sync and easily discoverable

sending the repo docs in content seems like "hiding" them from the repo

@daudix
Copy link
Contributor Author

daudix commented Oct 10, 2024

I understand your concerns, the content can't be directly under the docs directory, and I didn't know that the man pages are being generated from the docs, so I'll turn this into a draft until the details are worked out.

@daudix daudix marked this pull request as draft October 10, 2024 13:33
@89luca89
Copy link
Owner

I understand your concerns, the content can't be directly under the docs directory, and I didn't know that the man pages are being generated from the docs, so I'll turn this into a draft until the details are worked out.

got it thanks

maybe we can have ./docs in the main repo (like now) and symlink into content? would that work?

@daudix daudix marked this pull request as ready for review October 10, 2024 17:35
Copy link
Owner

@89luca89 89luca89 left a 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

@daudix daudix requested a review from 89luca89 October 12, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants