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

Alternative Jekyll theme for cleaner code #13

Open
snomos opened this issue Sep 28, 2023 · 6 comments
Open

Alternative Jekyll theme for cleaner code #13

snomos opened this issue Sep 28, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@snomos
Copy link
Member

snomos commented Sep 28, 2023

The present Jekyll theme has several shortcomings:

  • no sitemap/overview of available pages
  • the page TOC to the left is really a hack
  • does not play well with smaller screen sizes
  • no dark mode
  • not easily exentable
  • inline code is not clearly separated from the surrounding text
  • search results are still lousy

What is good about it is:

  • mostly good layout and typography = easy to read
  • relatively modern design

I would thus like to replace the current theme with something else. The requirement are:

  • Page TOC
  • Site map/view
  • builtin support for Mermaid, math (not important), charts (=no hacks to make it work)
  • responsive design
  • light and dark mode, both manual and automatic (= follows system)
  • easily extendable in config file or document config headers
  • better code & syntax formatting
  • preferably active community & development work
  • anonymised analytics
  • better search

Some candidates:

This issue is filed under giellalt.github.io, and obviously applies to that site. In addition it should also apply to most subsites (all language models, keyboard repos, dictionary repos, etc).

I am not too happy about the candidates, but they are so far the best I have found. Do you have any better suggestions @albbas and @flammie and @Phaqui ?

@snomos snomos added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 28, 2023
@flammie
Copy link
Contributor

flammie commented Sep 28, 2023

I have no strong opinions, but this: https://github.com/topics/jekyll-theme is a list of themes ordered by popularity, one of the ones high up could be good. I always jsut used ones in the dropdown menu on github pages settings :-)

@snomos
Copy link
Member Author

snomos commented Sep 28, 2023

Thanks for the link!

@snomos
Copy link
Member Author

snomos commented Sep 28, 2023

Both themes that I had found are high up on the list, and https://github.com/kitian616/jekyll-TeXt-theme is the one coming closest to my requirements. Unfortunately development has stopped a year ago it seems.

@snomos
Copy link
Member Author

snomos commented Oct 16, 2023

What about this one?

@albbas
Copy link
Contributor

albbas commented Oct 17, 2023

Looks nice

@snomos
Copy link
Member Author

snomos commented Oct 24, 2023

It is nice, but seems to require a blog style documentation - not fit at all for our documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants