Initial commit.

.github/workflows/deploy.yml

@@ -0,0 +1,69 @@
+name: Build documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: Writerside/allor-doc
+  ARTIFACT: webHelpALLOR-DOC2-all.zip
+  DOCKER_VERSION: 232.10165.1
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        uses: montudor/action-zip@v1
+        with:
+          args: unzip -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -0,0 +1 @@
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Nourepide
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.MD

@@ -0,0 +1,24 @@
+## About Allor Documentation
+
+This project was created in response to the ever-growing [README.MD](https://github.com/Nourepide/ComfyUI-Allor/blob/main/README.MD) file and the increasing size of the Allor repository due to images.
+
+It was decided to dedicate a separate project solely for documentation.
+
+This also facilitates a more convenient and faster addition/modification of information about Allor’s modules and nodes.
+
+## Building
+Allor Documentation is automatically built after each update using GitHub Actions and is deployed on GitHub Pages. 
+
+Manual builds from the terminal/console or in IDEs other than [Writeside](https://www.jetbrains.com/writerside/) are not currently supported.
+
+## Contributing
+
+Contributions to Allor Documentation are welcome and appreciated. Here are a few ways you can contribute:
+
+- **Proofreading**: Help us correct typos, grammatical errors, and inconsistencies in the documentation.
+- **Improving clarity**: Help us make our documentation clearer and more accessible.
+- **Providing examples**: Help us improve our documentation by providing or improving examples.
+- **Keeping documentation up-to-date**: Help us keep our documentation current as the project evolves.
+- **Improving structure and navigation**: Help us improve the structure and navigation of our documentation.
+
+To get started, please fork this repository, make your changes, and submit a pull request. We look forward to your contributions!

Writerside/allor-doc.tree

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="allor-doc"
+                 name="Allor Documentation"
+                 start-page="Allor-Doc.md">
+
+    <toc-element topic="Allor-Doc.md">
+        <toc-element topic="Modules.md"/>
+    </toc-element>
+</instance-profile>

Writerside/topics/Allor-Doc.md

@@ -0,0 +1 @@
+# About Allor

Writerside/topics/Modules.md

@@ -0,0 +1 @@
+# Modules

Writerside/writerside.cfg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+    <topics dir="topics" web-path="topics"/>
+    <images dir="images" web-path="ComfyUI-Allor-Doc"/>
+    <instance src="allor-doc.tree" web-path="/allor-doc/"/>
+</ihp>