chore(#179): update module section structure

druxt · Sep 1, 2021 · aa65c99 · aa65c99
1 parent 504b7cd
commit aa65c99
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 12 deletions.
diff --git a/docs/content/modules/blocks.md → docs/content/modules/blocks/README.md b/docs/content/modules/blocks.md → docs/content/modules/blocks/README.md
diff --git a/docs/content/modules/breadcrumb.md → docs/content/modules/breadcrumb/README.md b/docs/content/modules/breadcrumb.md → docs/content/modules/breadcrumb/README.md
diff --git a/docs/content/modules/entity.md → docs/content/modules/entity/README.md b/docs/content/modules/entity.md → docs/content/modules/entity/README.md
diff --git a/docs/content/modules/menu.md → docs/content/modules/menu/README.md b/docs/content/modules/menu.md → docs/content/modules/menu/README.md
diff --git a/docs/content/modules/router.md → docs/content/modules/router/README.md b/docs/content/modules/router.md → docs/content/modules/router/README.md
diff --git a/docs/content/modules/schema.md → docs/content/modules/schema/README.md b/docs/content/modules/schema.md → docs/content/modules/schema/README.md
diff --git a/docs/content/modules/site.md → docs/content/modules/site/README.md b/docs/content/modules/site.md → docs/content/modules/site/README.md
diff --git a/docs/content/modules/views.md → docs/content/modules/views/README.md b/docs/content/modules/views.md → docs/content/modules/views/README.md
diff --git a/docs/pages/modules/_.vue b/docs/pages/modules/_.vue
@@ -20,13 +20,14 @@ export default {
   name: "AppGuideDocument",
 
   async asyncData({ $content, error, params, store, route }) {
-    const path = params.pathMatch || "README";
+    const path = params.pathMatch
+      ? params.pathMatch.includes("/")
+        ? params.pathMatch
+        : params.pathMatch + "/README"
+      : "README";
     let response;
     try {
-      response = await $content(
-        "modules/",
-        params.pathMatch || "README"
-      ).fetch();
+      response = await $content("modules/", path).fetch();
     } catch (e) {
       return error({ message: "Document not found" });
     }

diff --git a/docs/pages/modules/index.vue b/docs/pages/modules/index.vue
@@ -10,7 +10,7 @@
     />
 
     <div
-      v-for="module of modules"
+      v-for="module of $store.state.modules"
       :key="module.title"
       class="card mb-5 shadow-lg hover:shadow-2xl"
     >

diff --git a/docs/store/index.js b/docs/store/index.js
@@ -1,16 +1,27 @@
 export const actions = {
   async nuxtServerInit({ commit }, { $content }) {
     try {
+      // Add Druxt modules to Vuex store.
+      const modulesIndex = await $content("api/README").only("toc").fetch()
+      const modules = await Promise.all(modulesIndex.toc
+        .filter((o) => o.id !== 'druxt')
+        .map((o) =>
+          $content(`modules/${o.id.split("-")[1]}/README`)
+            .only(["description", "dir", "title"])
+            .fetch()
+        )
+      )
+      console.log(modules)
+      commit("setModules", modules);
+
       // Add Modules menu children to the vuex store.
-      const moduleIndex = await $content("modules").sortBy("title").only(["path", "title"]).fetch();
-      const modules = moduleIndex
-        .filter((o) => !o.path.endsWith("/README"))
+      const moduleChildren = modules
         .map((o) => ({
           component: "NuxtLink",
           text: o.title,
-          props: { to: o.path },
+          props: { to: o.dir },
         }));
-      commit("addMenuChildren", { children: modules, parent: "/modules" });
+      commit("addMenuChildren", { children: moduleChildren, parent: "/modules" });
 
       // Add Guide menu children to the vuex store.
       const guideIndex = await $content("guide").only(["path", "title"]).fetch();
@@ -29,7 +40,6 @@ export const actions = {
         props: { to: o.path.replace("/README", "") },
       }));
       commit("addMenuChildren", { children: apiChildren, parent: "/api" });
-
     } catch (err) {
       console.log(err)
     }

diff --git a/docs/store/mutations.js b/docs/store/mutations.js
@@ -18,5 +18,15 @@ export default {
 
     // Return only the last 5 items.
     state.recent = recent.filter((o, index) => index < 5)
+  },
+
+  /**
+   * Set the Druxt modules list.
+   *
+   * @param {Object} state
+   * @param {Array} modules
+   */
+  setModules(state, modules) {
+    state.modules = modules
   }
 }
diff --git a/docs/store/state.js b/docs/store/state.js
@@ -49,6 +49,9 @@ export default () => ({
     children: [],
   }],
 
+  // Druxt modules.
+  modules: [],
+
   // Recently opened documents.
   recent: [],
 })