Add all docs from effector v23

.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+name: Github Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛎️ Checkout
+        uses: actions/checkout@v4
+
+      - name: 🐧 Use Node.js v20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: v20.x
+          cache: "pnpm"
+
+      - run: corepack enable
+      - run: pnpm install
+      - run: pnpm build
+      - run: pnpm search:build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: "./build"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,22 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+.idea

.prettierignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+.astro
+.vscode

.prettierrc

@@ -0,0 +1,21 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 100,
+  "plugins": ["prettier-plugin-tailwindcss", "prettier-plugin-organize-attributes"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro",
+        "plugins": [
+          "prettier-plugin-tailwindcss",
+          "prettier-plugin-astro",
+          "prettier-plugin-organize-attributes"
+        ]
+      }
+    }
+  ]
+}

AUTHORS

@@ -0,0 +1,140 @@
+Zero Bias <[email protected]>
+andretshurotshka <[email protected]>
+Dmitry Boldyrev <[email protected]>
+Sergey Sova <[email protected]>
+Alexander Khoroshikh <[email protected]>
+popuguytheparrot <[email protected]>
+github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+Igor Kamyshev <[email protected]>
+Sova <[email protected]>
+AlexandrHoroshih <[email protected]>
+Valery Kobzar <[email protected]>
+doasync <[email protected]>
+Egor Guscha <[email protected]>
+Illia Osmanov (iosmanov) <[email protected]>
+mg901 <[email protected]>
+Yan <[email protected]>
+Igor Ryzhov <[email protected]>
+Illia Osmanov <[email protected]>
+Arthur Irgashev <[email protected]>
+bloadvenro <[email protected]>
+YanLobat <[email protected]>
+Ilya <[email protected]>
+Kirill Mironov <[email protected]>
+Ainur Sharaev <[email protected]>
+Arutyunyan Artyom <[email protected]>
+drevoed <[email protected]>
+Nikita Nafranets <[email protected]>
+dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+popuguy <[email protected]>
+Aleksandr Osipov <[email protected]>
+Andrew Gopienko <[email protected]>
+bakugod <[email protected]>
+Victor Didenko <[email protected]>
+sterios_sav <[email protected]>
+Dmitrij Shuleshov <[email protected]>
+Viktor Pasynok <[email protected]>
+zukhrik <[email protected]>
+Mika Andrianarijaona <[email protected]>
+SLy <[email protected]>
+Spoki4 <[email protected]>
+uulaal <[email protected]>
+Antropov Andrey <[email protected]>
+Bohdan Petrov <[email protected]>
+Egor Aristov <[email protected]>
+sergey20x25 <[email protected]>
+Ainur <[email protected]>
+Alexander Belov <[email protected]>
+Anton Kosykh <[email protected]>
+Anton Yurovskykh <[email protected]>
+Arsen-95 <[email protected]>
+Denis Sikuler <[email protected]>
+Kirill <[email protected]>
+Komar0ff <[email protected]>
+Maxim Sidorov <[email protected]>
+Renat Sagdeev <[email protected]>
+Samir <[email protected]>
+Sozonov <[email protected]>
+Stanislav <[email protected]>
+Tauyekel Kunzhol <[email protected]>
+Victor <[email protected]>
+Vladimir Ivakin <[email protected]>
+[email protected] <[email protected]>
+allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
+cqh <[email protected]>
+ivanov-v <[email protected]>
+xaota <[email protected]>
+☃︎ <[email protected]>
+0xflotus <[email protected]>
+45m0d3u5 <[email protected]>
+7iomka <[email protected]>
+Abel Siqueira <[email protected]>
+Aleksandr Grigorii <[email protected]>
+Aleksei Arro <[email protected]>
+Aleksei Pudnikov <[email protected]>
+Alex Anokhin <[email protected]>
+Alexander Mikhaylov <[email protected]>
+Alexandrsv <[email protected]>
+Andrew Laiff <[email protected]>
+Artsiom Rymarchyk <[email protected]>
+DecliningLotus <[email protected]>
+Denis Maushov <[email protected]>
+Denis Skiba <[email protected]>
+Dmitry Dudin <[email protected]>
+Ed Prince <[email protected]>
+Egor Gorbachev <[email protected]>
+Gabriel Husek <[email protected]>
+Ilya Martynov <[email protected]>
+Infant Frontender <[email protected]>
+Ivan Oshchepkov <[email protected]>
+Jan Keromnes <[email protected]>
+Jesse Jackson <[email protected]>
+Joel Bandi <[email protected]>
+Kireev Mikhail <[email protected]>
+Kirill Tyurin <[email protected]>
+Kurzdor <[email protected]>
+Lebedev Konstantin <[email protected]>
+Leniorko <[email protected]>
+Ludovic Dem <[email protected]>
+MiiZZo <[email protected]>
+Mike Cann <[email protected]>
+Oleg <[email protected]>
+Oleh <[email protected]>
+Pasha Grekovich <[email protected]>
+Pavel Tereschenko <[email protected]>
+Rachael Dawn <[email protected]>
+Rafael Fakhreev <[email protected]>
+Raman Aktsisiuk <[email protected]>
+Robert Kuzhin <[email protected]>
+Roman <[email protected]>
+Satya Rohith <[email protected]>
+Sergey Belozyorcev <[email protected]>
+Shiyan7 <[email protected]>
+The Gitter Badger <[email protected]>
+Usman Yunusov <[email protected]>
+Vadim Filimonov <[email protected]>
+Vasili Sviridov <[email protected]>
+Vasili Svirydau <[email protected]>
+Victor Kolb <[email protected]>
+Victor-Nikliaiev <[email protected]>
+Vladislav <[email protected]>
+Vladislav Botvin <[email protected]>
+Will Heslam <[email protected]>
+WoodenPC <[email protected]>
+Yesset <[email protected]>
+alek-de-mik <[email protected]>
+anatolykopyl <[email protected]>
+ansunrisein <[email protected]>
+c01nd01r <[email protected]>
+dmitryplyaskin <[email protected]>
+gzaripov <[email protected]>
+houston[bot] <[email protected]>
+ilfey <[email protected]>
+kanno <[email protected]>
+leushkin <[email protected]>
+miyaokamarina <[email protected]>
+nulladdict <[email protected]>
+risenforces <[email protected]>
+seonmyung.lim <[email protected]>
+vladthelittleone <[email protected]>
+xxxue <[email protected]>

README.md

@@ -0,0 +1,44 @@
+# Documentation
+
+## Content files
+
+All files of the content can be written using MD or MDX inside `src/content/docs/[lang]`.
+
+Astro can find localized version via the same slug (path to the document) in the another directory:
+
+- `src/content/docs/[lang]/[slug].md` (_or `.mdx`_)
+- `src/content/docs/en/api/effector/clearNode.md`
+- `src/content/docs/ru/api/effector/clearNode.md`
+
+## Configuration
+
+The most basic setup is in `src/consts.ts`.
+
+Translation of the UI elements is in `src/languages.ts`.
+
+All navigation structure is in `src/navigation.ts`.
+
+## Run
+
+Simply install the `pnpm` and run:
+
+```shell
+pnpm install
+pnpm start
+```
+
+To fetch commits history, you need Github Personal Access Token. Just add it:
+
+```shell
+GITHUB_TOKEN=github_pat_REDACTED_TOKEN pnpm start
+```
+
+### Search
+
+By default search disabled on the local machine due to index requirements. But you can enable it by following steps:
+
+1. Build the docs — `COMPRESS=false pnpm build`
+2. Start search serve server — `pnpm search:dev`
+3. Start astro with env parameter `PUBLIC_SEARCH=true pnpm dev`
+
+`COMPRESS=false` disables compressing, to speed up build.

astro.config.ts

@@ -0,0 +1,56 @@
+import "dotenv/config";
+import { defineConfig } from "astro/config";
+import mdx from "@astrojs/mdx";
+import compress from "astro-compress";
+import preact from "@astrojs/preact";
+import tailwind from "@astrojs/tailwind";
+import directive from "remark-directive";
+import github from "remark-github";
+import breaks from "remark-breaks";
+import rehypeAutolinkHeadings from "rehype-autolink-headings";
+
+import { remarkHeadingId } from "@effector/remark-heading-id";
+
+import { admonitions } from "./plugins/admonitions";
+import { remarkFallbackLang } from "./plugins/remark-fallback-lang";
+
+// https://astro.build/config
+export default defineConfig({
+  site: process.env.NODE_ENV === "development" ? "http://localhost:4321" : `https://effector.dev`,
+  integrations: [
+    tailwind({ applyBaseStyles: false }),
+    preact({ compat: true }),
+    mdx({ extendMarkdownConfig: true }),
+    process.env.COMPRESS !== "false" && compress(),
+  ],
+  prefetch: true,
+  base: "/",
+  build: {
+    assets: "assets",
+  },
+  scopedStyleStrategy: "where",
+  markdown: {
+    syntaxHighlight: "prism",
+    remarkPlugins: [directive, admonitions, github, remarkHeadingId],
+    rehypePlugins: [
+      [
+        rehypeAutolinkHeadings,
+        {
+          behavior: "prepend",
+          properties: { class: "href" },
+        },
+      ],
+    ],
+  },
+  vite: {
+    server: {
+      proxy: {
+        "/_pagefind": {
+          target: "http://127.0.0.1:1414",
+          rewrite: (path) => path.replace(/^\/dist/, ""),
+        },
+      },
+    },
+  },
+  devToolbar: { enabled: false },
+});