➕ Add remove-markdown for descriptions

Author: AnandChowdhary

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@staart/site",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "module": "dist/module.js",
   "main": "dist/index.js",
   "bin": "./dist/index.js",
@@ -43,6 +43,7 @@
     "minimist": "^1.2.0",
     "node-cache": "^5.0.0",
     "recursive-readdir": "^2.2.2",
+    "remove-markdown": "^0.3.0",
     "sass": "^1.23.1",
     "signale": "^1.4.0",
     "sitemap": "^5.0.1",
@@ -57,6 +58,7 @@
     "@types/minimist": "^1.2.0",
     "@types/node": "^12.11.7",
     "@types/recursive-readdir": "^2.2.0",
+    "@types/remove-markdown": "^0.1.1",
     "@types/sass": "^1.16.0",
     "@types/signale": "^1.2.1",
     "@types/yaml": "^1.2.0",

src/generator.ts

@@ -29,6 +29,7 @@ import { StaartSiteConfig } from "./interfaces";
 import { getLastCommit, getGitHubRepoUrl } from "./github";
 import { parse as yaml } from "yaml";
 import frontMatter from "front-matter";
+import removeMarkdown from "remove-markdown";
 import { FrontMatter } from "./interfaces";
 
 export const getTemplate = async () => {
@@ -298,7 +299,16 @@ const generatePage = async (path: string, content: string) => {
             "title",
             "name"
           )) || "Staart Site"}`,
-    ...attributes
+    ...attributes,
+    description:
+      path === "index.html"
+        ? await getSiteMeta("description")
+        : attributes.description
+        ? attributes.description
+        : removeMarkdown(content).replace(
+            (await getTitle(content)) || "Staart Site",
+            ""
+          )
   };
   for await (const key of Object.keys(data)) {
     if (typeof data[key] === "string")

src/interfaces.ts

@@ -41,5 +41,6 @@ export interface FrontMatter {
   title: string;
   emoji: string;
   seoImage: string;
+  description: string;
   [index: string]: string;
 }

yarn.lock

@@ -127,6 +127,11 @@
   resolved "https://registry.yarnpkg.com/@types/relateurl/-/relateurl-0.2.28.tgz#6bda7db8653fa62643f5ee69e9f69c11a392e3a6"
   integrity sha1-a9p9uGU/piZD9e5p6facEaOS46Y=
 
+"@types/remove-markdown@^0.1.1":
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/@types/remove-markdown/-/remove-markdown-0.1.1.tgz#c79d3000df412526186b2af3808b85bee68bc907"
+  integrity sha512-SCYOFMHUqyiJU5M0V2gBB6UDdBhPwma34j0vYX0JgWaqp/74ila2Ops1jt5tB/C1UQXVXqK+is61884bITn3LQ==
+
 "@types/sass@^1.16.0":
   version "1.16.0"
   resolved "https://registry.yarnpkg.com/@types/sass/-/sass-1.16.0.tgz#b41ac1c17fa68ffb57d43e2360486ef526b3d57d"
@@ -4070,6 +4075,11 @@ remove-markdown@^0.2.2:
   resolved "https://registry.yarnpkg.com/remove-markdown/-/remove-markdown-0.2.2.tgz#66b0ceeba9fb77ca9636bb1b0307ce21a32a12a6"
   integrity sha1-ZrDO66n7d8qWNrsbAwfOIaMqEqY=
 
+remove-markdown@^0.3.0:
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/remove-markdown/-/remove-markdown-0.3.0.tgz#5e4b667493a93579728f3d52ecc1db9ca505dc98"
+  integrity sha1-XktmdJOpNXlyjz1S7MHbnKUF3Jg=
+
 remove-trailing-separator@^1.0.1:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz#c24bce2a283adad5bc3f58e0d48249b92379d8ef"