emilecok/ujs
1
0
Fork 0
Code Issues Pull Requests Projects 1 Releases Wiki Activity

Начало написания документации

Browse Source
This commit is contained in:
Alexander Popov 2024-01-09 19:38:35 +03:00
parent da9efcc3c5
commit 36160839ff
Signed by: iiiypuk
GPG Key ID: E47FE0AB36CD5ED6
6 changed files with 129 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
CHANGELOG.md Normal file
View File

70
docs/api.md Normal file
View File

@ -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);
// ...
// Добавляем холст игры/приложения на страницу в элемент <body>
window.addEventListener('DOMContentLoaded', () => {
document.body.appendChild(app.view);
});
```
## Класс `Scene`
Класс сцены.
### 🟢 Методы
### 🔷 Параметры
- `one` — `int` параметр
- `two` — `int` параметр
- `three` — (_необязательный_) `obj` параметр
### 🐎 Примеры использования
```javascript
// ...
```
## Пример `Объекта`
Описание `Объекта`
### 🟢 Методы
### 🔷 Параметры
- `one` — `int` параметр
- `two` — `int` параметр
- `three` — (_необязательный_) `obj` параметр
### 🐎 Примеры использования
```javascript
// ...
```

3
docs/examples.md Normal file
View File

@ -0,0 +1,3 @@
# 📦 Примеры
`⚠️ Этот раздел документации в разработке`

52
docs/index.md Normal file
View File

@ -0,0 +1,52 @@
# 🏠 ujs
**ujs** — JavaScript библиотека для разработки игр на HTML5/Canvas
## 💽 Установка и использование
### 💾 Установка
Необходимо скачать файл `ujs.js` и разместить его в директории проекта,
например по слеющуему пути `assets/js`.
По [этой ссылке](http://a2s.su/) (**_в данный момент ссылка не работает_**)
расположена последняя версия (`ujs-beta`) библиотеки.
Старые версии и историю изменений можно найти на старнице [🗒️ История версий](versions.md).
### ⌨️ Использование
Библиотека подключается как модуль из вашего JavaScript файла.
Предположим, что файл с Вашим основным кодом игры/приложения называется `game.js`
и подключён к проекту следующим образом.
```html
<!-- Файл index.html -->
<!DOCTYPE html>
<html lang="en">
<head>
<!-- ... -->
<script src="./game.js" type="module"></script>
<!-- ... -->
</head>
</html>
```
Для подключения библиотеки необходимо импортировать необходимые объекты библиотеки **ujs** (в данном случае импортируем все объекты)
с помощью директивы `import`.
```javascript
/* Файл game.js */
import * as ujs from './ujs.js';
```
## 📦 Примеры использования библиотеки
`⚠️ Этот раздел документации в разработке`
## 🧰 Докуменация API
Документация по [API](api.md) представлена на [следующей](api.md) странице.

3
docs/versions.md Normal file
View File

@ -0,0 +1,3 @@
# 🗒️ История версий
`⚠️ Этот раздел документации в разработке`

1
mkdocs.yml Normal file
View File

@ -0,0 +1 @@
site_name: ujs docs