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

Implement mdbook instead of custom rendering #1

Closed
wants to merge 2 commits into from

Conversation

clsource
Copy link

@clsource clsource commented Dec 2, 2024

This change have several benefits:

  • Can include longer examples.
  • Is searchable.
  • Uses standarized tools and formats (mdbook, markdown).
  • Can include example files directly from onyx code.

The main inspiration is Gleam Docs https://gleam.run/documentation/
So we can have a place to have tours, cheatsheets, cookbooks, articles and tutorials
outside of the main website and official book.

Drawbacks:

onyx.io/examples will change to a book format. Maybe would be best to have quick examples in the website separated from a more complete examples/cook book.

I will leave this PR for comments maybe is best to have this on its own repo.

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.

1 participant