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

Documenter.jl theme #165

Open
KronosTheLate opened this issue Sep 22, 2023 · 4 comments
Open

Documenter.jl theme #165

KronosTheLate opened this issue Sep 22, 2023 · 4 comments

Comments

@KronosTheLate
Copy link

I think that Documenter.jl looks great. I really like the icons on the top right (github, page theme, info). I also really like the sliding menu on mobile, and static menu on PC. I think recreating/coping that layout would and adding it as a template here would be nice.

The main reason now to use Documenter directly is how the pages are generated, where documenter focuses on stuff like docstrings, and franklin has a more general focus with more flexibility.

@tlienart
Copy link
Owner

tlienart commented Sep 26, 2023

Hello @KronosTheLate yeah I think that could be nice and might even be reasonably straightforward to do given the Documenter.jl repo is pretty clean. I don't think I can afford to do that soon but if someone wants to give it a shot, I'll definitely give a hand on the PR

Note: it's probably a good idea to start with Xranklin.jl directly (the beta for the next Franklin release).

@KronosTheLate
Copy link
Author

Great! I am not capable enough to make it happen, but at some point in the future someone will hopefully get round to this. So this issue will just represent my wish-list ^_^

Perhaps @mortenpi be able to, or know someone who is able to, help make this happen.

@mortenpi
Copy link

I almost certainly won't have the bandwidth for it. But if someone does want to embark on this, then I'd just say that the Documenter SCSS files should refactored anyway, and so maybe there would be some way to combine those efforts, and make the whole thing a bit more reusable.

@KronosTheLate
Copy link
Author

That sounds very interesting. If you see someone making efforts on the refactoring, feel free to point them to this thread.

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

No branches or pull requests

3 participants