!feat: depricate the description field for articles

aplosdev · Sep 8, 2024 · f788ac1 · f788ac1
1 parent b3b766d
commit f788ac1
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - The navigation bar first appears when you enter the page, as you scroll down it will disappear, and when you scroll up it will appear again (that way it won't take up space when you're reading, so you can focus on the content)
 
+- **Depricate the `description` field for articles**
+
+  - The `description` field for articles is now deprecated, and now the as a replacement, the content until the first `hr` element will be used as the description for the article in both the article list and the article itself.
+
 - Adaptive navigation island
 
 - Add an option to make authors not be displayed

diff --git a/docs/.vitepress/theme/ArticleList.vue b/docs/.vitepress/theme/ArticleList.vue
@@ -28,7 +28,7 @@
             >{{ post.title }}</a
           >
         </h3>
-        <p v-if="post.description">{{ post.description }}</p>
+        <div v-if="post.excerpt" v-html="post.excerpt"></div>
         <div class="post-details">
           <p class="date">
             {{ post.date }}

diff --git a/docs/.vitepress/theme/posts.data.ts b/docs/.vitepress/theme/posts.data.ts
@@ -4,6 +4,7 @@ interface Post {
   title: string;
   description: string;
   author: string;
+  excerpt: string | undefined;
   type: string;
   tags: string[];
 }
@@ -15,13 +16,14 @@ export default createContentLoader("demo/blog/posts/*.md", {
   excerpt: true,
   transform(raw): Post[] {
     return raw
-      .map(({ frontmatter }) => ({
+      .map(({ frontmatter, excerpt }) => ({
         title: frontmatter.title,
         description: frontmatter.description,
         tags: frontmatter.tags,
         author: frontmatter.author,
         type: frontmatter.type,
         date: formatDate(frontmatter.date),
+        excerpt,
       }))
       .sort((a, b) => new Date(b.date).getTime() - new Date(a.date).getTime());
   },

diff --git a/docs/demo/blog/posts/first-blog.md b/docs/demo/blog/posts/first-blog.md
@@ -17,6 +17,10 @@ tags:
   - Example
 ---
 
+Ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum nobis opinemur. Quod idem licet transferre in voluptatem, ut postea variari voluptas distinguique possit, augeri amplificarique non possit. At.
+
+---
+
 Credits to banner image: [Unsplash](https://unsplash.com/photos/a-herd-of-sheep-grazing-on-a-lush-green-field-yB3YWgyQIk0)
 
 > [!INFO] Info
@@ -25,8 +29,6 @@ Credits to banner image: [Unsplash](https://unsplash.com/photos/a-herd-of-sheep-
 > [!WARNING] Warning
 > ActivityPub comments have been disabled for version 1.4.0 as it was causing issues with the build process. It will be re-enabled in a future release.
 
-Ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum nobis opinemur. Quod idem licet transferre in voluptatem, ut postea variari voluptas distinguique possit, augeri amplificarique non possit. At.
-
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est.

diff --git a/docs/demo/blog/posts/ipsum.md b/docs/demo/blog/posts/ipsum.md
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: "Ipsum"
+title: Ipsum
 author:
   - Gabriel Cozma
 description: Why Ipsum is the best. It's great, simple, clean nice. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum.
@@ -15,7 +15,11 @@ tags:
   - Example
 ---
 
-Ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum nobis opinemur. Quod idem licet transferre in voluptatem, ut postea variari voluptas distinguique possit, augeri amplificarique non possit. At.
+Why Ipsum is the best. It's great, simple, clean nice. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum.
+
+---
+
+## Some more
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
 

diff --git a/docs/demo/blog/posts/lorem.md b/docs/demo/blog/posts/lorem.md
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: "Lorem"
+title: Lorem
 author:
   - Gabriel Cozma
 banner: https://images.unsplash.com/photo-1633885896832-fe1ea4be4a32?q=80&w=2838&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
@@ -16,9 +16,12 @@ tags:
   - Example
 ---
 
+Recently I've been likeing the idea of using Lorem Ipsum in my projects. It's great, simple, clean nice. I [think](https://example.org) that it's **really** good. The text is so nice and clean. It's great, simple, clean nice. The sky is _blue_, round, and so on. An Aerial View of a tracator in a field is really intresting, so intresting in fact, that I've been writing about it.
+
+---
+
 Credits to banner image: [Unsplash](https://unsplash.com/photos/an-aerial-view-of-a-tractor-in-a-field-FMzEdpO3Rko)
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum.
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione.
 

diff --git a/src/layouts/ArticleHead.vue b/src/layouts/ArticleHead.vue
@@ -53,11 +53,6 @@
           }}</span>
         </span>
       </small>
-      <br />
-      <p v-if="frontmatter.description" id="description">
-        {{ frontmatter.description }}
-      </p>
-      <hr />
     </div>
   </div>
 </template>