feat(git-changelog): add option to hide header (#260)

nolebase · Jul 13, 2024 · f2f6734 · f2f6734
1 parent c2fb0c0
commit f2f6734
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue b/packages/vitepress-plugin-git-changelog/src/client/components/Changelog.vue
@@ -94,15 +94,18 @@ const reversedCommits = computed(() => {
 </script>
 
 <template>
-  <h2 :id="t('changelog.titleId') || t('changelog.title')">
+  <h2 v-if="!options.hideHeader" :id="t('changelog.titleId') || t('changelog.title')">
     {{ t('changelog.title') }}
     <a class="header-anchor" :href="`#${t('changelog.titleId') || t('changelog.title')}`" :aria-label="`Permalink to '${t('changelog.title')}'`" />
   </h2>
-  <em v-if="!commits.length" opacity="70">{{ t('noLogs', { omitEmpty: true }) || t('changelog.noData') }}</em>
+  <div v-if="!commits.length" :class="options.hideHeader && 'mt-6'" class="italic" opacity="70">
+    {{ t('noLogs', { omitEmpty: true }) || t('changelog.noData') }}
+  </div>
   <div
     v-else
     :class="[
       isFreshChange ? 'bg-green/16' : 'bg-$vp-custom-block-details-bg',
+      options.hideHeader && 'mt-6',
     ]"
     class="vp-nolebase-git-changelog vp-nolebase-git-changelog-history vp-nolebase-git-changelog-history-list vp-nolebase-git-changelog-history-container"
     rounded-lg p-4

diff --git a/packages/vitepress-plugin-git-changelog/src/client/types.ts b/packages/vitepress-plugin-git-changelog/src/client/types.ts
@@ -126,6 +126,10 @@ export interface Options {
    * @default 7
    */
   numCommitHashLetters?: number
+  /**
+   * Whether to hide the git-changelog h2 header
+   */
+  hideHeader?: boolean
 }
 
 export interface Commit {