Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Checklist for v1 #1

Open
4 of 15 tasks
MarkKremer opened this issue Aug 29, 2024 · 1 comment
Open
4 of 15 tasks

Checklist for v1 #1

MarkKremer opened this issue Aug 29, 2024 · 1 comment

Comments

@MarkKremer
Copy link
Contributor

MarkKremer commented Aug 29, 2024

v1

  • Make root URL work. Either by adding a redirect to the first page of the first section, or by properly supporting an index page (in the menu).
  • URL's and URL rewrites are final. Number prefixes and .html suffixes are stripped. Must work on the dev server too.
  • Test with Markdown elements used in the Beep & Pixel docs.
  • Code blocks without specified language have the proper styling.
  • Make the action a composite action so it takes care of the GitHub Pages actions. This is difficult to maintain.

Future

  • Images are clickable. Opens either a popup with the full size image or the image on GitHub.
  • Headings link to their own anchor.
  • Allow some HTML in Markdown. E.g. <br>.
  • Make UI work good on phones.
  • Add good search.
  • SEO
  • Align logo better & optimize SVG.
  • Different logo's different projects.
  • Other UI tweaks.
  • Custom 404 page.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants
@MarkKremer and others