docsify

2023-04-30 17:39:03 +03:00
parent 51dbf116c1
commit c52b91c007
12 changed files with 2097 additions and 16 deletions
@@ -13,7 +13,7 @@ fi

 # editorconfig
 echo "Checking by EditorConfig..."
-ec . &> /dev/null
+ec -exclude 'node_modules' . &> /dev/null

 if [[ "$?" == 0 ]]; then
  echo "✅ EditorConfig"
@@ -1,10 +1,10 @@
-# ⚠️ STATUS: DEVELOPMENT
+# ⚠️ IN DEVELOPMENT

-![engine_icon](/test/icons/apple-touch-icon.png)
+![engine_icon](test/icons/apple-touch-icon.png)

 # Documentation

- 🇷🇺 [Russian](docs/ru.md)
+- 🇷🇺 [Russian](docs/ru/)

 # Build `ENGINE`

@@ -0,0 +1,5 @@
+# ⚠️ IN DEVELOPMENT
+
+## 🧻 Documentation
+
+- [API](us/api.md)
@@ -0,0 +1,2 @@
+- 🇷🇺 [Russian](/ru/)
+- 🇺🇸 [English](/)
@@ -0,0 +1 @@
+../../test/icons/apple-touch-icon.png
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>ujs</title>
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+	<meta name="description" content="Description">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+	<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+	<div id="app"></div>
+
+	<script>
+		window.$docsify = {
+			name: 'ujs',
+			repo: 'https://git.a2s.su/emilecok/ujs',
+			logo: '/assets/icon.png',
+			nativeEmoji: true,
+			loadNavbar: true,
+			nameLink: {
+				'/ru/': '#/ru/',
+				'/': '#/',
+			},
+			alias: {
+				'/ru/(.*)': '/ru/$1',
+			},
+			search: {
+				noData: {
+					'/ru/': 'Нет результатов!',
+					'/': 'No results!',
+				},
+				paths: 'auto',
+				placeholder: {
+					'/ru/': 'Поиск',
+					'/': 'Search',
+				},
+				pathNamespaces: ['/ru'],
+			},
+		}
+	</script>
+
+	<!-- Docsify v4 -->
+	<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+	<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
+</body>
+</html>
@@ -0,0 +1,5 @@
+# ⚠️ В РАЗРАБОТКЕ
+
+## 🧻 Документация
+
+- [API](/ru/api.md)
@@ -1,4 +1,4 @@
-# App
+# 🔵 App

 Основной класс движка.

@@ -20,10 +20,10 @@
 }
 ```

- backgroundColor — фон холста.  
+- `backgroundColor` — фон холста.  
  По умолчанию `#ffcc68`.

- welcome — `bool` тип.  
+- `welcome` — `bool` тип.  
  Отображает информацию о движке в **Console**.  
  По умолчанию `true`.

@@ -43,7 +43,7 @@ window.addEventListener('DOMContentLoaded', () => {
 });
 ```

-# Scene
+# 🔵 Scene

 Класс сцены.

@@ -61,7 +61,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# SceneLayer
+# 🔵 SceneLayer

 Класс слоя сцены.

@@ -79,7 +79,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# Object
+# 🔵 Object

 Класс объекта.

@@ -93,7 +93,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# Rect
+# 🔵 Rect

 ...

@@ -107,7 +107,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# StrokeRect
+# 🔵 StrokeRect

 ...

@@ -121,7 +121,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# Sprite
+# 🔵 Sprite

 ...

@@ -135,7 +135,7 @@ window.addEventListener('DOMContentLoaded', () => {
 ...
 ```

-# TiledSprite
+# 🔵 TiledSprite

 ...

@@ -0,0 +1 @@
+`contribute`
@@ -5,9 +5,11 @@
    "build": "rm -rf ./dist/ && rollup src/js/main.js --file dist/engine-$(npm pkg get version | tr -d '\"').js --format es",
    "prettier-check": "prettier --check .",
    "prettier-write": "prettier --write .",
-    "editorconfig-check": "ec ."
+    "editorconfig-check": "ec -exclude 'node_modules' .",
+    "docs-serve": "docsify serve docs"
  },
  "devDependencies": {
-    "prettier": "2.8.7"
+    "prettier": "2.8.7",
+    "docsify-cli": "^4.4.4"
  }
 }