argnist · argnist · May 10, 2023 · May 10, 2023 · May 11, 2023 · May 11, 2023
diff --git a/.DS_Store b/.DS_Store
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,21 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+tab_width = 4
+max_line_length = off
+
+[*.{js,ts,vue,css,json,yml}]
+indent_style = space
+tab_width = 2
+
+[*.md]
+indent_style = space
+tab_width = 2
+max_line_length = off
+trim_trailing_whitespace = false
diff --git a/.env b/.env
@@ -0,0 +1 @@
+SPONSOR_LINK=https://modx.pro/about
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+custom: ["https://www.tinkoff.ru/sl/2V9U9RrcJZP", "https://yoomoney.ru/fundraise/RPkkYwNcL7A.230131", "http://qiwi.com/p/77012827737"]
diff --git a/.github/ISSUE_TEMPLATE/incorrect.md b/.github/ISSUE_TEMPLATE/incorrect.md
@@ -0,0 +1,12 @@
+---
+name: Неверная информация
+about: Сообщить о проблеме, когда страница неправильно или неопределенно описывает что-то, что должно быть улучшено.
+---
+
+## Затронутые страницы
+
+Пожалуйста, предоставьте ссылку на страницу (страницы), у которой есть проблема, или, что еще лучше, ссылку на исходный файл в хранилище. Для длинных страниц, пожалуйста, укажите приблизительно, где проблема (номера заголовков или строк)
+
+## Что нужно улучшить?
+
+Будьте максимально конкретны: есть ли опечатка, неправильная заглавная буква MODX, или весь раздел нуждается в работе? Что неясно или неправильно? Если на форумах обсуждалась неточность или неясное описание или неточность, добавьте ссылку на это обсуждение.
diff --git a/.github/ISSUE_TEMPLATE/request.md b/.github/ISSUE_TEMPLATE/request.md
@@ -0,0 +1,12 @@
+---
+name: Запрос новой документации
+about: Запросить документацию о том, что в настоящее время полностью отсутствует в документации. 
+---
+
+## Запрос новой документации
+
+В какой теме отсутствует документация, которую вы бы хотели добавить? В каком разделе документации это должно указываться? На какого типа пользователей должна ориентироваться документация?
+
+## Соответствующие источники
+
+Если есть какой-либо соответствующий источник уже доступен, пожалуйста, включите ссылки. Это могут быть сообщения в блогах или статьи на сторонних сайтах, темы форумов, разговоры в социальных сетях и т. Д.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+## Описание улучшений
+
+Есть какая-то конкретная причина для этого изменения?
+Если недавнее изменение в ядре MODX вызвало изменение, пожалуйста, включите ссылку на соответствующий запрос на pull-request.
+
+## Актуальные проблемы
+
+Если возможно, укажите ссылку или id соответствующих проблем, чтобы их можно было закрыть после вливания.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,31 @@
+name: Deploy
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    if: github.repository_owner == 'modx-pro'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+      - run: npm install --frozen-lockfile
+      - name: Build
+        run: npm run build
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+      - uses: easingthemes/ssh-deploy@main
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+          ARGS: '--archive --compress --delete --exclude="/redirect.php"'
+          SOURCE: ".vitepress/dist/"
+          REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
+          REMOTE_USER: ${{ secrets.REMOTE_USER }}
+          TARGET: ${{ secrets.REMOTE_TARGET }}
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,22 @@
+name: Lint
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: reviewdog/action-markdownlint@v0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          filter_mode: file
+          fail_on_error: true
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+.idea
+.DS_Store
+.vitepress/cache
+.vitepress/dist
+node_modules
+
+.temp
+*.log
+package-lock.json
diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc
@@ -0,0 +1,15 @@
+{
+    "line-length": false,
+    "link-fragments": false,
+    "no-inline-html": {
+        "allowed_elements": ["Badge", "DocsComponentsList", "ul", "ol", "li"]
+    },
+    "fenced-code-language": false,
+    "no-duplicate-heading": {
+        "allow_different_nesting": true,
+        "siblings_only": true
+    },
+    "single-title": {
+        "front_matter_title": ""
+    }
+}
diff --git a/.markdownlintignore b/.markdownlintignore
@@ -0,0 +1,3 @@
+node_modules
+plop-templates
+**/parts/**/*.md
diff --git a/.vitepress/config/en.ts b/.vitepress/config/en.ts
@@ -0,0 +1,126 @@
+import type { DefaultTheme, LocaleConfig } from 'vitepress'
+import type { DocsTheme } from '../theme/types'
+import { generateSidebar } from '../theme/plugins/sidebar'
+import { components } from '../theme/plugins/component'
+import 'dotenv/config'
+
+export const SITE_NAME = 'Documentation hub for MODX extras and more'
+export const META_DESCRIPTION = 'A simple and easy-to-use Open-Source project by and for the community, where you can find and explore the documentation of all popular MODX extras, and developers can easily describe their'
+
+export const searchLocale: Record<string, Partial<Omit<DefaultTheme.LocalSearchOptions, 'locales'>>> = {
+  en: {
+    translations: {
+      button: {
+        buttonText: 'Search',
+        buttonAriaLabel: 'Search'
+      },
+      modal: {
+        resetButtonTitle: 'Reset search',
+        backButtonTitle: 'Close search',
+        noResultsText: 'No results for',
+        footer: {
+          selectText: 'to select',
+          selectKeyAriaLabel: 'enter',
+          navigateText: 'to navigate',
+          navigateUpKeyAriaLabel: 'up arrow',
+          navigateDownKeyAriaLabel: 'down arrow',
+          closeText: 'to close',
+          closeKeyAriaLabel: 'escape'
+        }
+      }
+    }
+  },
+}
+
+export const config: LocaleConfig<DocsTheme.Config> = {
+  en: {
+    label: 'English',
+    lang: 'en',
+    description: META_DESCRIPTION,
+
+    head: [
+      ['meta', { property: 'og:site_name', content: SITE_NAME }],
+    ],
+
+    themeConfig: {
+      nav: getNav(),
+
+      sidebar: {
+        '/en/components/': generateSidebar({
+          root: ['docs/en/components/*.md', 'docs/en/components/*/index.md'],
+          ignore: ['docs/en/components/index.md'],
+        }),
        '/en/guide/': getGuideSidebar(),
+      },
+
+      outline: {
+        label: 'On this page',
+        level: 'deep',
+      },
+
+      teamSectionTitle: 'Team',
+      sponsor: {
+        message: 'This service is free and open source, and its support and development depends on donations.',
+        linkText: 'Become a sponsor!',
+        link: process.env.SPONSOR_LINK,
+      },
+
+      docFooter: {
+        prev: 'Previous page',
+        next: 'Next page',
+      },
+      editLink: {
+        pattern: 'https://github.com/modx-pro/Docs/edit/master/docs/:path',
+        text: 'Suggest changes to this page',
+      },
+
+      components: components.filter(component => component.path.startsWith('en/components/')),
+    },
+  }
+}
+
+function getGuideSidebar(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Introduction',
+      items: [
+        { text: 'About', link: '/en/guide/about' },
+        { text: 'Getting Started', link: '/en/guide/getting-started' },
+        { text: 'Markdown', link: '/en/guide/markdown' },
+        { text: 'VitePress Features', link: '/en/guide/vitepress' },
+        { text: 'Frontmatter', link: '/en/guide/frontmatter' },
+      ],
+    },
+  ]
+}
+
+function getNav(): DefaultTheme.NavItem[] {
+  const guideItems: (DefaultTheme.NavItemWithLink | DefaultTheme.NavItemChildren)[] = [
+    { text: 'About', link: '/en/guide/about' },
+    { text: 'Getting Started', link: '/en/guide/getting-started' },
+    { text: 'Markdown', link: '/en/guide/markdown' },
+    { text: 'VitePress Features', link: '/en/guide/vitepress' },
+    { text: 'Frontmatter', link: '/en/guide/frontmatter' },
+  ]
+
+  if (process.env.SPONSOR_LINK) {
+    guideItems.push({
+      items: [
+        { text: '❤️ Become a sponsor!', link: process.env.SPONSOR_LINK }
+      ],
+    })
+  }
+
+  return [
+    {
+      text: 'Extras',
+      link: '/en/components/',
+      activeMatch: '/en/components/',
+    },
+    {
+      text: 'Introduction',
+      activeMatch: '/en/guide/',
+      items: guideItems,
+    },
+  ]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		custom: ["https://www.tinkoff.ru/sl/2V9U9RrcJZP", "https://yoomoney.ru/fundraise/RPkkYwNcL7A.230131", "http://qiwi.com/p/77012827737"]