Skip to content

Commit b24cb82

Browse files
committed
fix: Update workflow steps and MkDocs configuration for clarity and consistency
1 parent 66c91d0 commit b24cb82

2 files changed

Lines changed: 9 additions & 11 deletions

File tree

.github/workflows/docs.yml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,32 @@ jobs:
1616
runs-on: ubuntu-latest
1717

1818
steps:
19-
# --- 1. Забираем код ---
19+
# --- 1. Checkout repository ---
2020
- name: Checkout repository
2121
uses: actions/checkout@v4
2222

23-
# --- 2. Устанавливаем Node для генерации OpenAPI ---
23+
# --- 2. Set up Node.js for OpenAPI generation ---
2424
- name: Set up Node.js
2525
uses: actions/setup-node@v4
2626
with:
27-
node-version: '22' # или твоя версия
27+
node-version: '22'
2828
cache: 'npm'
2929

3030
- name: Install Node deps
3131
run: npm ci
3232

33-
# --- 3. Генерируем openapi.yaml ---
33+
# --- 3. Generate openapi.yaml ---
3434
- name: Generate OpenAPI schema
3535
run: npm run openapi:generate
36-
# или, если твой скрипт принимает аргументы:
37-
# run: npx tsx scripts/generate-openapi.ts --out docs/openapi.yaml
3836

39-
# Проверим, что файл появился
37+
# Verify that the file was created
4038
- name: Verify OpenAPI file exists
4139
run: test -f dist/docs/openapi.yaml
42-
40+
4341
- name: Copy OpenAPI file to docs
4442
run: cp dist/docs/openapi.yaml docs/content/openapi.yaml
4543

46-
# --- 4. Устанавливаем Python и MkDocs ---
44+
# --- 4. Set up Python and MkDocs ---
4745
- name: Set up Python
4846
uses: actions/setup-python@v5
4947
with:
@@ -55,7 +53,7 @@ jobs:
5553
python -m pip install --upgrade pip
5654
pip install -r requirements.txt
5755
58-
# --- 5. Собираем MkDocs ---
56+
# --- 5. Build MkDocs site ---
5957
- name: Build MkDocs site
6058
working-directory: docs
6159
run: mkdocs build --clean

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ theme:
3939

4040
plugins:
4141
- swagger-ui:
42-
spec_url: ./content/openapi.yaml
42+
spec_url: https://jodit.github.io/jodit-nodejs/openapi.yaml
4343
outfile: api-reference.md
4444
- search
4545
- awesome-pages

0 commit comments

Comments
 (0)