From 36160839ff286b66aacca5329dd1e0c791587b8a Mon Sep 17 00:00:00 2001 From: Alexander Popov Date: Tue, 9 Jan 2024 19:38:35 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9D=D0=B0=D1=87=D0=B0=D0=BB=D0=BE=20=D0=BD?= =?UTF-8?q?=D0=B0=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8=D1=8F=20=D0=B4=D0=BE?= =?UTF-8?q?=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 0 docs/api.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/examples.md | 3 +++ docs/index.md | 52 +++++++++++++++++++++++++++++++++++ docs/versions.md | 3 +++ mkdocs.yml | 1 + 6 files changed, 129 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 docs/api.md create mode 100644 docs/examples.md create mode 100644 docs/index.md create mode 100644 docs/versions.md create mode 100644 mkdocs.yml 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