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.

Sign up for GitHub

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

add js memory tutorial #2421

Merged
merged 10 commits into from
Mar 28, 2023
Merged

add js memory tutorial #2421

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cdf3ce9
add js tutorial
FloVanGH Mar 13, 2023
07465af
cleanup
FloVanGH Mar 27, 2023
0f1e7ab
code review feedback
FloVanGH Mar 28, 2023
1e098b9
Update docs/tutorial/node/src/conclusion.md
FloVanGH Mar 28, 2023
1f5fe22
Update docs/tutorial/node/src/creating_the_tiles_from_js.md
FloVanGH Mar 28, 2023
d281850
Update docs/tutorial/node/src/getting_started.md
FloVanGH Mar 28, 2023
dd8e1e3
Update docs/tutorial/node/src/getting_started.md
FloVanGH Mar 28, 2023
edec75e
code review feedback
FloVanGH Mar 28, 2023
d174261
Update docs/tutorial/node/src/game_logic_in_js.md
FloVanGH Mar 28, 2023
98e1c9f
Update docs/tutorial/node/src/getting_started.md
FloVanGH Mar 28, 2023
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
Prev Previous commit
Next Next commit
code review feedback
  • Loading branch information
@FloVanGH
FloVanGH committed Mar 28, 2023
commit 0f1e7ab606a55d567d34a0fd68f372860841ce86
6 changes: 5 additions & 1 deletion .github/workflows/build_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ jobs:
- name: "C++ Tutorial Docs"
run: mdbook build
working-directory: docs/tutorial/cpp
- name: "NodeJS Tutorial Docs"
run: mdbook build
working-directory: docs/tutorial/node
- name: "Slint Language Documentation"
run: cargo xtask slintdocs --show-warnings
- name: "Node docs"
Expand All @@ -102,8 +105,9 @@ jobs:
docs/site
docs/tutorial/rust/book/html
docs/tutorial/cpp/book/html
docs/tutorial/node/book/html
- name: "Check for docs warnings in internal crates"
run: cargo +nightly doc --workspace --no-deps --all-features --exclude slint-node --exclude mcu-board-support --exclude printerdemo_mcu --exclude carousel --exclude test-* --exclude plotter
- name: Clean cache # Don't cache docs to avoid them including removed classes being published
run: |
rm -rf target/doc target/cppdocs target/slintdocs api/node/docs docs/tutorial/rust/book docs/tutorial/cpp/book
rm -rf target/doc target/cppdocs target/slintdocs api/node/docs docs/tutorial/rust/book docs/tutorial/cpp/book docs/tutorial/node/book
2 changes: 2 additions & 0 deletions docs/site/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,8 @@ <h2>Documentation</h2>
/>
<strong>Using Slint in a NodeJS Project (Beta)</strong>
<a class="btn" href="node">NodeJS Documentation</a>
<br />
<a class="btn" href="tutorial/node">NodeJS Tutorial</a>
</li>
</ul>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/node/src/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
In this tutorial, we use JavaScript as the host programming language. We also support other programming languages like
[Rust](https://slint-ui.com/docs/rust/slint/) or [C++](https://slint-ui.com/docs/cpp/).
FloVanGH marked this conversation as resolved.
Show resolved Hide resolved

You will need a development environment with [node.js 16](https://nodejs.org/download/release/v16.19.1/) and [npm](https://www.npmjs.com/) installed.
You will need a development environment with [node.js 16](https://nodejs.org/download/release/v16.19.1/) and [npm](https://www.npmjs.com/) installed. More recent
versions of NodeJS are currently not supported, check [Issue #2220](https://github.com/slint-ui/slint/issues/2220).
FloVanGH marked this conversation as resolved.
Show resolved Hide resolved

We're going to use `slint-ui` as `npm` dependency.

Expand Down Expand Up @@ -40,5 +41,4 @@ and a window will appear with the green "Hello World" greeting.

![Screenshot of initial tutorial app showing Hello World](https://slint-ui.com/blog/memory-game-tutorial/getting-started.png "Hello World")

Feel free to use your favorite IDE for this purpose.
We just keep it simple here for the purpose of this blog.x
Feel free to use your favorite IDE for this purpose.