diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..2bc591a --- /dev/null +++ b/docs/api.md @@ -0,0 +1,70 @@ +# π§° ΠΠΎΠΊΡΠΌΠ΅Π½Π°ΡΠΈΡ API + +## ΠΠ»Π°ΡΡ `App` + +ΠΡΠ½ΠΎΠ²Π½ΠΎΠΉ ΠΊΠ»Π°ΡΡ ΠΏΡΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΡ **ujs**. + +### π’ ΠΠ΅ΡΠΎΠ΄Ρ + +### π· ΠΠ°ΡΠ°ΠΌΠ΅ΡΡΡ + +- `width` β `int` ΡΠΈΡΠΈΠ½Π° Ρ ΠΎΠ»ΡΡΠ° +- `height` β `int` Π²ΡΡΠΎΡΠ° Ρ ΠΎΠ»ΡΡΠ° +- `options` β (_Π½Π΅ΠΎΠ±ΡΠ·Π°ΡΠ΅Π»ΡΠ½ΡΠΉ_) `obj` Π΄ΠΎΠΏΠΎΠ»Π½ΠΈΡΠ΅Π»ΡΠ½ΡΠ΅ ΠΎΠΏΡΠΈΠΈ + +```javascript +let options = { + backgroundColor: '#ffcc68', // ΡΠΎΠ½ΠΎΠ²ΡΠΉ ΡΠ²Π΅Ρ Ρ ΠΎΠ»ΡΡΠ° + welcome: true, // ΠΎΡΠΎΠ±ΡΠ°ΠΆΠ΅Π½ΠΈΠ΅ ΠΏΡΠΈΠΌΠ΅ΡΡΡΠ²ΠΈΡ Π² ΠΊΠΎΠ½ΡΠΎΠ»ΠΈ +}; +``` + +### π ΠΡΠΈΠΌΠ΅ΡΡ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΡ + +```javascript +// Π‘ΠΎΠ·Π΄Π°ΡΠΌ ΠΏΡΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠ΅ app Ρ ΡΠ°Π·ΠΌΠ΅ΡΠΎΠΌ Ρ ΠΎΠ»ΡΡΠ° 320 Π½Π° 240 ΠΏΠΈΠΊΡΠ΅Π»Π΅ΠΉ +let app = new ujs.App(320, 240); + +// ... + +// ΠΠΎΠ±Π°Π²Π»ΡΠ΅ΠΌ Ρ ΠΎΠ»ΡΡ ΠΈΠ³ΡΡ/ΠΏΡΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΡ Π½Π° ΡΡΡΠ°Π½ΠΈΡΡ Π² ΡΠ»Π΅ΠΌΠ΅Π½Ρ
+window.addEventListener('DOMContentLoaded', () => { + document.body.appendChild(app.view); +}); +``` + +## ΠΠ»Π°ΡΡ `Scene` + +ΠΠ»Π°ΡΡ ΡΡΠ΅Π½Ρ. + +### π’ ΠΠ΅ΡΠΎΠ΄Ρ + +### π· ΠΠ°ΡΠ°ΠΌΠ΅ΡΡΡ + +- `one` β `int` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ +- `two` β `int` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ +- `three` β (_Π½Π΅ΠΎΠ±ΡΠ·Π°ΡΠ΅Π»ΡΠ½ΡΠΉ_) `obj` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ + +### π ΠΡΠΈΠΌΠ΅ΡΡ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΡ + +```javascript +// ... +``` + +## ΠΡΠΈΠΌΠ΅Ρ `ΠΠ±ΡΠ΅ΠΊΡΠ°` + +ΠΠΏΠΈΡΠ°Π½ΠΈΠ΅ `ΠΠ±ΡΠ΅ΠΊΡΠ°` + +### π’ ΠΠ΅ΡΠΎΠ΄Ρ + +### π· ΠΠ°ΡΠ°ΠΌΠ΅ΡΡΡ + +- `one` β `int` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ +- `two` β `int` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ +- `three` β (_Π½Π΅ΠΎΠ±ΡΠ·Π°ΡΠ΅Π»ΡΠ½ΡΠΉ_) `obj` ΠΏΠ°ΡΠ°ΠΌΠ΅ΡΡ + +### π ΠΡΠΈΠΌΠ΅ΡΡ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΡ + +```javascript +// ... +``` diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..641e049 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,3 @@ +# π¦ ΠΡΠΈΠΌΠ΅ΡΡ + +`β οΈ ΠΡΠΎΡ ΡΠ°Π·Π΄Π΅Π» Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ Π² ΡΠ°Π·ΡΠ°Π±ΠΎΡΠΊΠ΅` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..99edce9 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,52 @@ +# π ujs + +**ujs** β JavaScript Π±ΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠ° Π΄Π»Ρ ΡΠ°Π·ΡΠ°Π±ΠΎΡΠΊΠΈ ΠΈΠ³Ρ Π½Π° HTML5/Canvas + +## π½ Π£ΡΡΠ°Π½ΠΎΠ²ΠΊΠ° ΠΈ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΠ΅ + +### πΎ Π£ΡΡΠ°Π½ΠΎΠ²ΠΊΠ° + +ΠΠ΅ΠΎΠ±Ρ ΠΎΠ΄ΠΈΠΌΠΎ ΡΠΊΠ°ΡΠ°ΡΡ ΡΠ°ΠΉΠ» `ujs.js` ΠΈ ΡΠ°Π·ΠΌΠ΅ΡΡΠΈΡΡ Π΅Π³ΠΎ Π² Π΄ΠΈΡΠ΅ΠΊΡΠΎΡΠΈΠΈ ΠΏΡΠΎΠ΅ΠΊΡΠ°, +Π½Π°ΠΏΡΠΈΠΌΠ΅Ρ ΠΏΠΎ ΡΠ»Π΅ΡΡΡΠ΅ΠΌΡ ΠΏΡΡΠΈ `assets/js`. + +ΠΠΎ [ΡΡΠΎΠΉ ΡΡΡΠ»ΠΊΠ΅](http://a2s.su/) (**_Π² Π΄Π°Π½Π½ΡΠΉ ΠΌΠΎΠΌΠ΅Π½Ρ ΡΡΡΠ»ΠΊΠ° Π½Π΅ ΡΠ°Π±ΠΎΡΠ°Π΅Ρ_**) +ΡΠ°ΡΠΏΠΎΠ»ΠΎΠΆΠ΅Π½Π° ΠΏΠΎΡΠ»Π΅Π΄Π½ΡΡ Π²Π΅ΡΡΠΈΡ (`ujs-beta`) Π±ΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠΈ. + +Π‘ΡΠ°ΡΡΠ΅ Π²Π΅ΡΡΠΈΠΈ ΠΈ ΠΈΡΡΠΎΡΠΈΡ ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠΉ ΠΌΠΎΠΆΠ½ΠΎ Π½Π°ΠΉΡΠΈ Π½Π° ΡΡΠ°ΡΠ½ΠΈΡΠ΅ [ποΈ ΠΡΡΠΎΡΠΈΡ Π²Π΅ΡΡΠΈΠΉ](versions.md). + +### β¨οΈ ΠΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΠ΅ + +ΠΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠ° ΠΏΠΎΠ΄ΠΊΠ»ΡΡΠ°Π΅ΡΡΡ ΠΊΠ°ΠΊ ΠΌΠΎΠ΄ΡΠ»Ρ ΠΈΠ· Π²Π°ΡΠ΅Π³ΠΎ JavaScript ΡΠ°ΠΉΠ»Π°. + +ΠΡΠ΅Π΄ΠΏΠΎΠ»ΠΎΠΆΠΈΠΌ, ΡΡΠΎ ΡΠ°ΠΉΠ» Ρ ΠΠ°ΡΠΈΠΌ ΠΎΡΠ½ΠΎΠ²Π½ΡΠΌ ΠΊΠΎΠ΄ΠΎΠΌ ΠΈΠ³ΡΡ/ΠΏΡΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΡ Π½Π°Π·ΡΠ²Π°Π΅ΡΡΡ `game.js` +ΠΈ ΠΏΠΎΠ΄ΠΊΠ»ΡΡΡΠ½ ΠΊ ΠΏΡΠΎΠ΅ΠΊΡΡ ΡΠ»Π΅Π΄ΡΡΡΠΈΠΌ ΠΎΠ±ΡΠ°Π·ΠΎΠΌ. + +```html + + + + + + + + + + +``` + +ΠΠ»Ρ ΠΏΠΎΠ΄ΠΊΠ»ΡΡΠ΅Π½ΠΈΡ Π±ΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠΈ Π½Π΅ΠΎΠ±Ρ ΠΎΠ΄ΠΈΠΌΠΎ ΠΈΠΌΠΏΠΎΡΡΠΈΡΠΎΠ²Π°ΡΡ Π½Π΅ΠΎΠ±Ρ ΠΎΠ΄ΠΈΠΌΡΠ΅ ΠΎΠ±ΡΠ΅ΠΊΡΡ Π±ΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠΈ **ujs** (Π² Π΄Π°Π½Π½ΠΎΠΌ ΡΠ»ΡΡΠ°Π΅ ΠΈΠΌΠΏΠΎΡΡΠΈΡΡΠ΅ΠΌ Π²ΡΠ΅ ΠΎΠ±ΡΠ΅ΠΊΡΡ) +Ρ ΠΏΠΎΠΌΠΎΡΡΡ Π΄ΠΈΡΠ΅ΠΊΡΠΈΠ²Ρ `import`. + +```javascript +/* Π€Π°ΠΉΠ» game.js */ + +import * as ujs from './ujs.js'; +``` + +## π¦ ΠΡΠΈΠΌΠ΅ΡΡ ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°Π½ΠΈΡ Π±ΠΈΠ±Π»ΠΈΠΎΡΠ΅ΠΊΠΈ + +`β οΈ ΠΡΠΎΡ ΡΠ°Π·Π΄Π΅Π» Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ Π² ΡΠ°Π·ΡΠ°Π±ΠΎΡΠΊΠ΅` + +## π§° ΠΠΎΠΊΡΠΌΠ΅Π½Π°ΡΠΈΡ API + +ΠΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ ΠΏΠΎ [API](api.md) ΠΏΡΠ΅Π΄ΡΡΠ°Π²Π»Π΅Π½Π° Π½Π° [ΡΠ»Π΅Π΄ΡΡΡΠ΅ΠΉ](api.md) ΡΡΡΠ°Π½ΠΈΡΠ΅. diff --git a/docs/versions.md b/docs/versions.md new file mode 100644 index 0000000..cdaff82 --- /dev/null +++ b/docs/versions.md @@ -0,0 +1,3 @@ +# ποΈ ΠΡΡΠΎΡΠΈΡ Π²Π΅ΡΡΠΈΠΉ + +`β οΈ ΠΡΠΎΡ ΡΠ°Π·Π΄Π΅Π» Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ Π² ΡΠ°Π·ΡΠ°Π±ΠΎΡΠΊΠ΅` diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2da9527 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: ujs docs