Skip to content

Commit dabf72b

Browse files
committed
refactor: update docs workflow for Markdown instead of AsciiDoc
- Remove Asciidoctor setup (no longer needed) - Remove AsciiDoc conversion step - Add step to prepare Markdown documentation files - GitHub Pages can serve Markdown files directly - All documentation has been migrated from .adoc to .md format
1 parent fa47688 commit dabf72b

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

.github/workflows/gh-pages.yml

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,6 @@ jobs:
2525
git config --local user.name "GitHub Action"
2626
shell: bash
2727

28-
- name: Asciidoctor Setup
29-
run: |
30-
sudo apt-get install -y asciidoctor
31-
shell: bash
32-
3328
# Avoids keeping the commit history for the gh-pages branch,
3429
# so that such a branch keeps only the last commit.
3530
# But this slows down the GitHub Pages website build process.
@@ -43,20 +38,13 @@ jobs:
4338
git checkout --orphan gh-pages main 1>/dev/null
4439
shell: bash
4540

46-
- name: Converting AsciiDoc files to HTML
41+
- name: Prepare Markdown documentation
4742
run: |
48-
if find . -name "*.adoc" -print -quit | grep -q .; then
49-
find . -name "*.adoc" -print0 | xargs -0 asciidoctor -b html --attribute=nofooter
50-
for FILE in `find . -name "README.html"`; do
51-
mv "$FILE" "`dirname $FILE`/index.html";
52-
done
53-
for FILE in `find . -name "*.html"`; do
54-
git add -f "$FILE";
55-
done
56-
find . -name "*.adoc" -print0 | xargs -0 git rm -f --cached
57-
else
58-
echo "No .adoc files found, skipping AsciiDoc conversion"
59-
fi
43+
# Markdown files are already in the repository, no conversion needed
44+
# GitHub Pages can serve Markdown files directly
45+
echo "Markdown documentation files are ready for GitHub Pages"
46+
# Add all Markdown files
47+
find . -name "*.md" -exec git add -f {} \;
6048
shell: bash
6149

6250
- name: Remove irrelevant files from gh-pages branch

0 commit comments

Comments
 (0)