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

Empty Footer isn't empty #1658

Closed
kimhanm opened this issue Dec 17, 2024 · 5 comments
Closed

Empty Footer isn't empty #1658

kimhanm opened this issue Dec 17, 2024 · 5 comments
Labels
bug Something isn't working

Comments

@kimhanm
Copy link
Contributor

kimhanm commented Dec 17, 2024

Describe the bug
Emptying the footer in quartz.layout doesn't create an empty footer.

Expected behavior
The page shows an empty footer

Actual behaviour
The footer displays "Created with Quartz v4.4.0 © 2024"

Additional context
This extra line is defined inside the footer component at quartz/components/Footer.tsx lines 16-19:

<p>
  {i18n(cfg.locale).components.footer.createdWith}{" "}
  <a href="https://quartz.jzhao.xyz/">Quartz v{version}</a> © {year}
</p>

Suggested solution
Move this line out of the component definition and into quartz.layout.ts.

@kimhanm kimhanm added the bug Something isn't working label Dec 17, 2024
@aarnphm
Copy link
Collaborator

aarnphm commented Dec 18, 2024

not a bug really, if you don't want footer you can use Component.Spacer()

@aarnphm aarnphm closed this as completed Dec 18, 2024
@kimhanm
Copy link
Contributor Author

kimhanm commented Dec 18, 2024

The problem is that you don't have an obvious way to control the footer.
The credits line is not documented at all and your suggested solution leaves no way to set the footer to the users liking.
Instead of having to choose between footer with hard-coded line and no footer at all, one should be given the option to define the contents of the footer in quartz.layout.ts, just like the other components.

@saberzero1
Copy link
Collaborator

The problem is that you don't have an obvious way to control the footer.
The credits line is not documented at all and your suggested solution leaves no way to set the footer to the users liking.
Instead of having to choose between footer with hard-coded line and no footer at all, one should be given the option to define the contents of the footer in quartz.layout.ts, just like the other components.

There are many such cases.

Here is a non-exhaustive list of things that are hard-coded visual elements. These are not configurable in quartz.config.ts, but can be easily customized with small code changes.

  • Individual language specific component names. (e.g. English Explorer title and German Graph title.)
  • Date formatting independent from locale.
  • Font ligatures
  • Code block theme colors
  • Code block code-language specific colors
  • Explorer folder collapse/open icon
  • Text direction (default ltr, some languages are written rtl however (Hebrew, Arabic, Persian, etc.))
  • Default light mode or dark mode when none are set by user system.
  • Non-standard/additional callouts types.

My point is, just remove or replace the Quartz credits if you don't like it. The project is MIT licensed. You're free to put whatever you want in the footer of your Quartz site.

@kimhanm
Copy link
Contributor Author

kimhanm commented Dec 18, 2024

You could simply say that it's not the priority of the maintainers and have no plans on adding this functionality.
But by closing the issue, you are saying that you intend on keeping this functionality, even if a PR that directly addresses the raised point arrives.

I would like to know if my (or others) efforts in improving the functionality and/or documentation would be wasted because the devs cannot fathom an empty footer producing an undocumented non-empty footer is a bad idea.

@saberzero1
Copy link
Collaborator

You could simply say that it's not the priority of the maintainers and have no plans on adding this functionality.

We did say that. We gave you two alternative options to address the issue you raised, neither of which seemed satisfactory to you.

But by closing the issue, you are saying that you intend on keeping this functionality, even if a PR that directly addresses the raised point arrives.

Yes.

I would like to know if my (or others) efforts in improving the functionality and/or documentation would be wasted because the devs cannot fathom an empty footer producing an undocumented non-empty footer is a bad idea.

We welcome all contributions. And as with all contributions, we aim to give feedback on all opened pull requests. These can be to accept the proposed changes, request changes, or reject changes altogether. Such is the process of open source.

We put a lot of effort in ensuring that the Quartz community is as welcoming and supportive as possible to everyone, but especially inexperienced users and non-programmers. We have spend countless hours out of the goodness of our hearts to accomplish this. Because we care about Quartz and we care about this community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants