Skip to content

Commit 680f5be

Browse files
committed
Create docusaurus site; update doc build workflow
1 parent 328a8e6 commit 680f5be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+20330
-28
lines changed

.github/workflows/docs-build.yml

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,17 @@ jobs:
1717
with:
1818
persist-credentials: false
1919

20-
- name: Setup ruby
21-
uses: ruby/setup-ruby@efbf473cab83af4468e8606cc33eca9281bb213f # v1.256.0
20+
- uses: actions/setup-node@v4
2221
with:
23-
ruby-version: '3.3'
24-
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
25-
cache-version: 0 # Increment this number if you need to re-download cached gems
26-
working-directory: ./docs
22+
node-version: 20.x
2723

28-
- name: Setup pages
29-
id: pages
30-
uses: actions/configure-pages@v5
31-
32-
- name: Build with Jekyll
33-
run: bundle exec jekyll build --baseurl "$PAGES_PATH"
34-
working-directory: ./docs
35-
env:
36-
PAGES_PATH: ${{ steps.pages.outputs.base_path }}
37-
38-
- name: Check links
24+
- name: Build website
3925
run: |
40-
bundle exec htmlproofer \
41-
--disable-external \
42-
--assume_extension '.html' \
43-
--swap-urls "^${PAGES_PATH}/:/" \
44-
./_site
45-
working-directory: ./docs
46-
env:
47-
PAGES_PATH: ${{ steps.pages.outputs.base_path }}
26+
cd website
27+
npm ci
28+
npm run build
4829
49-
- name: Upload site assets as artifact
50-
id: deployment
30+
- name: Upload website artifact
5131
uses: actions/upload-pages-artifact@v3
5232
with:
53-
path: ./docs/_site
33+
path: ./website/build

docs/imagecreator/README.md

Lines changed: 1 addition & 0 deletions

docs/imagecreator/api/api.md

Lines changed: 1 addition & 0 deletions

docs/imagecreator/api/cli.md

Lines changed: 1 addition & 0 deletions
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Configuration",
3+
"position": 1
4+
}

docs/imagecreator/api/configuration/configuration.md

Lines changed: 1 addition & 0 deletions

docs/imagecreator/developer-guide.md

Lines changed: 1 addition & 0 deletions

docs/imagecreator/quick-start/quick-start.md

Lines changed: 1 addition & 0 deletions

docs/imagecustomizer/README.md

Lines changed: 1 addition & 0 deletions
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "API",
3+
"position": 4
4+
}

0 commit comments

Comments
 (0)