Merge pull request #92 from HLCaptain/docs

`npm` to `yarn` and fixes
HLCaptain · Mar 26, 2023 · fa355f4 · fa355f4
2 parents 3297ce6 + eba40a3
commit fa355f4
Show file tree

Hide file tree

Showing 10 changed files with 12,184 additions and 37,382 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -17,13 +17,13 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: npm
-          cache-dependency-path: docs/package-lock.json
+          cache: yarn
+          cache-dependency-path: docs
 
       - name: Install dependencies
-        run: npm ci
+        run: yarn install --frozen-lockfile
       - name: Build website
-        run: npm run build
+        run: yarn build
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
@@ -32,11 +32,11 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Build output to publish to the `gh-pages` branch:
-          publish_dir: ./docs/build
+          publish_dir: ./build
           # The following lines assign commit authorship to the official
           # GH-Actions bot for deploys to `gh-pages` branch:
           # https://github.com/actions/checkout/issues/13#issuecomment-724415212
           # The GH actions bot is used by default if you didn't specify the two fields.
           # You can swap them out with your own user credentials.
           user_name: github-actions[bot]
-          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -17,10 +17,10 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: npm
-          cache-dependency-path: docs/package-lock.json
+          cache: yarn
+          cache-dependency-path: docs
 
       - name: Install dependencies
-        run: npm ci
+        run: yarn install --frozen-lockfile
       - name: Test build website
-        run: npm run build
+        run: yarn build
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -43,13 +43,13 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl: 'https://github.com/HLCaptain/jay-android/tree/main/docs/docs',
+          editUrl: 'https://github.com/HLCaptain/jay-android/edit/main/docs',
         },
         blog: {
           showReadingTime: true,
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl: 'https://github.com/HLCaptain/jay-android/tree/main/docs/blog',
+          editUrl: 'https://github.com/HLCaptain/jay-android/edit/main/docs',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
@@ -61,8 +61,10 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      colorMode: {
+        defaultMode: 'dark',
+      },
       // Replace with your project's social card
-      image: 'img/docusaurus-social-card.jpg',
       navbar: {
         title: 'Jay',
         logo: {
@@ -71,9 +73,9 @@ const config = {
         },
         items: [
           {
-            type: 'doc',
-            docId: 'intro',
+            type: 'docSidebar',
             position: 'left',
+            sidebarId: 'docsSidebar',
             label: 'Docs',
           },
           {