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] Fixes and style improvements for GitHub Pages doc site #637

Merged
merged 4 commits into from
May 30, 2024

Conversation

ericyhwang
Copy link
Contributor

  • Fix a multitude of broken links and formatting
  • Switch template examples to "jinja" language that's supported by rouge-ruby syntax highlighter, with style customizations
    • The old derby-site used a custom Derby syntax highlighter written in JS. That won't work with the new Jekyll docs with rouge-ruby as syntax highlighter.
    • After some experimentation, "jinja" with some small style customizations is good enough, so I don't feel it's worth the time at the moment to write a custom Ruby lexer for Derby templates.
  • Customize theme with Derby colors from derby-site
  • Point main README to new GH Pages doc site
    • I'll update the old derby-site later to have its Docs header link point to GH Pages.

Example of fixed code formatting and new theme colors:

Screenshot 2024-05-29 at 5 14 48 PM

Copy link
Contributor

@craigbeck craigbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ericyhwang ericyhwang merged commit fb29b1c into master May 30, 2024
5 checks passed
@ericyhwang ericyhwang deleted the doc-cleanup branch May 30, 2024 17:41
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.

2 participants