feat: add contributors option for landing (resolves #48)

unjs · Feb 21, 2024 · d750691 · d750691
1 parent f34b546
commit d750691
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 0 deletions.
diff --git a/docs/.config/docs.jsonc b/docs/.config/docs.jsonc
@@ -13,6 +13,7 @@
     // "heroLinks": {
     //   "stackblitz": { "icon": "i-heroicons-play", "to": "https://stackblitz.com/github/unjs/docs/tree/main/template" }
     // },
+    "contributors": true,
     "features": [
       { "title": "Eazy to use", "description": "Focus on writing your documentation with Markdown, not tooling." },
       { "title": "Nuxt powered", "description": "Made with Nuxt, Nuxt Content, Nuxt SEO and Nuxt UI Pro." },

diff --git a/docs/1.guide/index.md b/docs/1.guide/index.md
@@ -37,6 +37,7 @@ Build for production:
   "github": "unjs/packageName",
   "redirects": {},
   "landing": {
+    "contributors": true,
     "heroCode": "",
     "heroLinks": {},
     "features": []

diff --git a/layers/core/app/modules/content/landing.mjs b/layers/core/app/modules/content/landing.mjs
@@ -38,6 +38,8 @@ export function genLanding(docsConfig) {
     // Features
     featuresTitle: '',
     features: [],
+
+    _github: docsConfig.github,
   })
 
   landing._heroMdTitle =

diff --git a/layers/core/app/pages/index.vue b/layers/core/app/pages/index.vue
@@ -90,4 +90,12 @@ const hero = computed(() => {
       </UPageGrid>
     </ULandingSection>
   </template>
+
+  <ULandingSection v-if="page.contributors && page._github" title="Made by community">
+    <UContainer>
+      <a :href="`https://github.com/${page._github}/graphs/contributors`" target="_blank">
+        <img :src="`https://contrib.rocks/image?repo=${page._github}`" />
+      </a>
+    </UContainer>
+  </ULandingSection>
 </template>
diff --git a/schema/config.d.ts b/schema/config.d.ts
@@ -8,6 +8,7 @@ export interface DocsConfig {
   themeColor?: string
   redirects?: Record<string, string>
   automd?: any
+  contributors?: boolean
   landing?:
     | false
     | {

diff --git a/schema/config.json b/schema/config.json
@@ -60,6 +60,10 @@
               "type": "string",
               "description": "Page description"
             },
+            "contributors": {
+              "type": "boolean",
+              "description": "Show contributors section"
+            },
             "features": {
               "type": "array",
               "description": "Features section description",

diff --git a/template/.config/docs.json b/template/.config/docs.json
@@ -6,6 +6,7 @@
   "github": "unjs/packageName",
   "redirects": {},
   "landing": {
+    "contributors": false,
     "heroCode": "",
     "heroLinks": {},
     "features": []