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

docs: Add pandoc theme to docs site #1277

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

Conversation

aslak01
Copy link

@aslak01 aslak01 commented Nov 25, 2024

📑 Description

Added a nicer theme (with dark mode support) to the pandoc markdown-html conversion, tweaked colors to match astrotheme.

Credit to https://github.com/jez/pandoc-markdown-css-theme

Preview: https://aslak01.github.io/astrocommunity/

ℹ Additional Information

Moved bash script and resources to /docs/

Copy link

Review Checklist

Does this PR follow the [Contribution Guidelines](development guidelines)? Following is a partial checklist:

Proper conventional commit scoping:

  • If you are adding a new plugin, the scope would be the name of the category it is being added into. ex. feat(utility): added noice.nvim plugin

  • If you are modifying a pre-existing plugin or pack, the scope would be the name of the plugin folder. ex. fix(noice-nvim): fix LSP handler error

  • Pull request title has the appropriate conventional commit type and scope where the scope is the name of the pre-existing directory in the project as described above

  • README is properly formatted and uses fenced in links with <url> unless they are inside a [title](url)

  • Entry returns a single plugin spec with the new plugin as the only top level spec (not applicable for recipes or packs).

  • Proper usage of opts table rather than setting things up with the config function.

  • Proper usage of specs table for all specs that are not dependencies of a given plugin (not applicable for recipes or packs).

aslak01 and others added 4 commits November 26, 2024 00:22
fix: paths

fix paths redusx

fix paths again

chore: discard more

chore: discard other

tweak path

read path
path

debug echo

debug ls 2
fix: delete overrides

fix: break

chore disable jekyll

fix: apply light-dark

fix styles & fonts

tweaks

mv assets

ignore built output

tweaks to theme
@aslak01 aslak01 changed the title Docs: Add pandoc theme to docs site docs: Add pandoc theme to docs site Nov 27, 2024
@Kamilcuk
Copy link
Contributor

Hi. The page looks just incredibly stunning. Check review checklist - follow "proper conventional commit scoping", see https://www.conventionalcommits.org/en/v1.0.0/ . Your commits should start with build(docs): for example. The page visual is just 5 out of 5 stars.

@aslak01 aslak01 changed the title docs: Add pandoc theme to docs site build(docs): Add pandoc theme to docs site Dec 16, 2024
@aslak01
Copy link
Author

aslak01 commented Dec 17, 2024

Thanks @Kamilcuk, and thanks for the original script, it was really inspiring to see such a simple way to hook into github files/actions rather than using pre made abstractions. I would like to mess around with this system more, but at the moment I'm too busy. I can imagine some bash script component system to make it easier to work on individial bits of the generated site, or something like it.

Also, seems like your suggested title does not pass the repo checks either, to me it looks like it's expecting a pr to target a specific already existing plugin, but I didn't have the time to look at it too much.

@Uzaaft
Copy link
Member

Uzaaft commented Dec 17, 2024

Turns out the theme is not changing only in the arc browser. On safari it changes fine. @aslak01 Did you by any chance test on firefox/chrome?

@Uzaaft
Copy link
Member

Uzaaft commented Dec 17, 2024

Hi. The page looks just incredibly stunning. Check review checklist - follow "proper conventional commit scoping", see conventionalcommits.org/en/v1.0.0 . Your commits should start with build(docs): for example. The page visual is just 5 out of 5 stars.

Wrong. Its docs.

@Uzaaft Uzaaft changed the title build(docs): Add pandoc theme to docs site builddocs: Add pandoc theme to docs site Dec 17, 2024
@Uzaaft Uzaaft changed the title builddocs: Add pandoc theme to docs site docs: Add pandoc theme to docs site Dec 17, 2024
@Uzaaft
Copy link
Member

Uzaaft commented Dec 17, 2024

See f5f3442

@Uzaaft
Copy link
Member

Uzaaft commented Dec 17, 2024

Chrome works fine. Firefox as well.

Fuck Arc, less than 1% uses it. LGTM.

@mehalter U merge pookie?

@Uzaaft
Copy link
Member

Uzaaft commented Dec 17, 2024

@aslak01 any reason why you added a shitton of fonts? Cant they be fetched at runtime?

@ALameLlama
Copy link
Member

Pretty sure we can remove most of these just by doing

@import url('https://fonts.googleapis.com/css2?family=Inter:wght@100;200;300;400;500;600;700;800;900&display=swap');

should be able to remove the font folder and font.css if we include that import in the theme.css

@aslak01
Copy link
Author

aslak01 commented Dec 18, 2024

Yep, that'd work but I prefer to self-host fonts rather than depend on google fonts where I can personally. It's the same pattern that's in use on astronvim.com.

If you look in the network tab, only two fonts files are loaded, the rest are just there in case we need them in the future, since Inter is an open source font and provides the entire set of weights and styles as a set.

@aslak01
Copy link
Author

aslak01 commented Dec 28, 2024

@Uzaaft I can change it to fetch the font remotely if you want to make that a requirement but in my opinion "locally" hosted fonts are better.

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.

4 participants