Skip to content

Reworked the docs #3

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

sedyh
Copy link

@sedyh sedyh commented Apr 5, 2025

Notes

It is preferable to set up github pages to include additional resource in base url (like the repo name) to be able to host multiple sites on one account.

After the merge, it will be necessary to change some of the addresses containing the base-url and resource name. This is difficult to do internally, because the account name and url are different in my fork.

Contributing process after merge

  • Clone the repo.
  • Copy-paste an existing page for reference to: /content/<type>/<name>/_index.md.
  • Make edits for your widget, following the page structure:
[title]
[description]
[image-preview]
[spoiler>full-code-example]

### Options
###### Name
[description]

[tabs=name]

[tab=value]
[image-preview]
[short-code-example]
[spoiler>full-code-example]
[/tab]

[/tabs]
  • Make a code example implementing a ebiten.Game for each option value in: /gen/examples/<name>/main.go.
  • Use special // START <name> and // END <name> comments for marking snippets or skipping unnecessary parts.
  • Import your example to /gen/main.go and add it to []Scene{...}.
  • Test it with go run gen -e <package>.
  • Generate previews and code examples with go run gen.
  • Use generated snippets and previews from your code in page tags.
  • Test the site via: hugo serve.
  • Make a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant