Skip to content

chore: add wide logo and update docs #4

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

Merged
merged 1 commit into from
Sep 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/assets/images/favicon.ico.licence
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
variation from icon source: https://godotengine.org/assets/press/icon_color.svg
1 change: 1 addition & 0 deletions docs/assets/images/godot-js.png.licence
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
variation from icon source: https://godotengine.org/assets/press/icon_color.svg
Binary file added docs/assets/images/godotJS-logo-275w-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/images/godotJS-logo-275w-dark.png.licence
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
variation from icon source: https://github.com/why-try313/godot-ECMAScript-cookbook/blob/master/wiki-images/godotJS-logo-275w.png
Binary file added docs/assets/images/godotJS-logo-275w.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/images/godotJS-logo-275w.png.licence
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
icon source: https://github.com/why-try313/godot-ECMAScript-cookbook/blob/master/wiki-images/godotJS-logo-275w.png
22 changes: 22 additions & 0 deletions docs/css/extra.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ godot.register_property(MyClass, "number_value", {
});
```

For more detail on how to use it, [click here](https://github.com/Geequlim/ECMAScript/issues/24#issuecomment-655584829).
For more detail on how to use it, [click here](https://github.com/godotjs/javascript/issues/24#issuecomment-655584829).
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Download the binaries from the [release page](https://github.com/GodotExplorer/E
- `git clone https://github.com/godotengine/godot.git`
- This branch uses version `4.1` so checkout the version with: `git checkout 4.1`
- Clone this module and put it into `godot/modules/javascript`:
- `git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript` or
- `git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript`
- `git clone [email protected]:godotjs/javascript.git godot/modules/javascript` or
- `git clone https://github.com/godotjs/javascript.git godot/modules/javascript`
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html)
- Use `scons` with those additional options `warnings=extra werror=yes module_text_server_fb_enabled=yes` to show all potential errors:
- Windows: `scons platform=windows warnings=extra werror=yes module_text_server_fb_enabled=yes`
Expand Down
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: GodotJS
site_url: https://godotjs.github.io
repo_url: https://github.com/Geequlim/ECMAScript
repo_url: https://github.com/godotjs/javascript
site_description: JS/TS language binding for Godot

extra_css:
- css/extra.css
nav:
- Home: index.md
- Docs:
Expand Down
Loading