Fix jekyll config to keep generated api docs; remove doscs/api from g…

…itignore
derbyjs · Jun 28, 2024 · 27ed7f9 · 27ed7f9
1 parent e843830
commit 27ed7f9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 8 deletions.
diff --git a/.github/workflows/docs-gh-pages.yml b/.github/workflows/docs-gh-pages.yml
@@ -37,8 +37,6 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 18
-      - name: Build with Typedoc
-        run: npm i && npm run docs
       - name: Setup Ruby
         uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
         with:
@@ -49,9 +47,11 @@ jobs:
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v4
-      - name: Build with Jekyll
-        # Outputs to the './_site' directory by default
-        run: cd $DOCS_DIR && bundle install && bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+      - name: Build with Typedoc
+        run: npm i && npm run docs
+      - name: Build documentaiton site
+        working-directory: ${{ env.DOCS_DIR }}
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
       - name: Upload artifact

diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,3 @@
 node_modules
 .vscode
 dist/
-docs/api/
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -40,8 +40,7 @@ markdown: kramdown
 theme: just-the-docs
 color_scheme: derby-light # just-the-docs theme customization
 permalink: /:path/:name
-keep_files:
-  - api/
+keep_files: [api]
 
 # just-the-docs customization
 callouts:
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,4 +3,3 @@ @@
     node_modules
     .vscode
     dist/
-    docs/api/