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

Migrate to Zola #1522

Open
senekor opened this issue Mar 11, 2025 · 1 comment
Open

Migrate to Zola #1522

senekor opened this issue Mar 11, 2025 · 1 comment

Comments

@senekor
Copy link
Contributor

senekor commented Mar 11, 2025

Benefits:

  • better maintainability
  • link checking
  • auto-reloading development server

Downsides:

  • It might be necessary to duplicate the date of the post in the front matter (in date and path), because zola doesn't support template strings for the path or something similar. (Maybe we can only have path in the front matter and extract the date from it in our scripts?)

I think we should definitely do #1511 first, for maximum confidence in the transition. There is a good chance Zola will do some things differently. Ideally, we would incrementally change the output of our custom generator, until it matches the output of zola.

@senekor
Copy link
Contributor Author

senekor commented Apr 1, 2025

At this point, I see two big blockers for making the migration a no-op for the snapshot tests:

  • Zola calls our URLs "ugly" and doesn't support them: Support ugly urls getzola/zola#840. We can preserve support for old links with redirects, but the directory structure will be different.
  • The generated heading ids for internal links are different than before. I suspect this is because we use comrak and Zola uses pulldown-cmark. I might try to migrate the custom site generator to pulldown-cmark to reduce the final diff, but I also might decide it's not worth it.

I'm thinking I could create two throwaway commits containing the normally-ignored public/ directory. Then the diff can easily be viewed in GitHub's UI, making review of the final migration step more convenient.

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

1 participant