@hestia-earth/guide 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -2,4 +2,6 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.2](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.1...v0.0.2) (2024-10-29)
+
 ### 0.0.1 (2024-10-29)

package/content/hestia-101/content.json

@@ -0,0 +1,3 @@
+{
+  "content": "# HESTIA 101"
+}

package/content/hestia-101/content.md

@@ -0,0 +1 @@
+# HESTIA 101

package/content/index.json

@@ -0,0 +1,84 @@
+{
+  "pages": {
+    "hestia-101": {
+      "content": {
+        "id": "hestia-101",
+        "mdPath": "hestia-101/content.md",
+        "jsonPath": "hestia-101/content.json",
+        "title": "HESTIA 101",
+        "createdAt": "2024-10-29T07:59:37.000Z",
+        "updatedAt": "2024-10-29T07:59:37.000Z"
+      }
+    },
+    "models": {
+      "content": {
+        "id": "models",
+        "mdPath": "models/content.md",
+        "jsonPath": "models/content.json",
+        "title": "Applying Models",
+        "createdAt": "2024-10-29T07:59:37.000Z",
+        "updatedAt": "2024-10-29T07:59:37.000Z"
+      },
+      "pages": {
+        "models-introduction": {
+          "content": {
+            "id": "models-introduction",
+            "mdPath": "models/introduction.md",
+            "jsonPath": "models/introduction.json",
+            "title": "Introduction",
+            "createdAt": "2024-10-29T07:59:37.000Z",
+            "updatedAt": "2024-10-29T07:59:37.000Z",
+            "tags": {
+              "next": [
+                "documentation"
+              ]
+            }
+          }
+        },
+        "models-documentation": {
+          "content": {
+            "id": "models-documentation",
+            "mdPath": "models/documentation.md",
+            "jsonPath": "models/documentation.json",
+            "title": "Documentation",
+            "createdAt": "2024-10-29T07:59:37.000Z",
+            "updatedAt": "2024-10-29T07:59:37.000Z",
+            "tags": {
+              "previous": [
+                "introduction"
+              ],
+              "next": [
+                "contributing"
+              ]
+            }
+          }
+        },
+        "models-contributing": {
+          "content": {
+            "id": "models-contributing",
+            "mdPath": "models/contributing.md",
+            "jsonPath": "models/contributing.json",
+            "title": "Contributing",
+            "createdAt": "2024-10-29T07:59:37.000Z",
+            "updatedAt": "2024-10-29T07:59:37.000Z",
+            "tags": {
+              "previous": [
+                "documentation"
+              ]
+            }
+          }
+        },
+        "models-faq": {
+          "content": {
+            "id": "models-faq",
+            "mdPath": "models/faq.md",
+            "jsonPath": "models/faq.json",
+            "title": "FAQ",
+            "createdAt": "2024-10-29T07:59:37.000Z",
+            "updatedAt": "2024-10-29T07:59:37.000Z"
+          }
+        }
+      }
+    }
+  }
+}

package/content/models/content.json

@@ -0,0 +1,3 @@
+{
+  "content": "# Applying Models"
+}

package/content/models/content.md

@@ -0,0 +1 @@
+# Applying Models

package/content/models/contributing.json

@@ -0,0 +1,8 @@
+{
+  "tags": {
+    "previous": [
+      "documentation"
+    ]
+  },
+  "content": "# Contributing\n\n"
+}

package/content/models/contributing.md

@@ -0,0 +1,2 @@
+# Contributing
+

package/content/models/documentation.json

@@ -0,0 +1,11 @@
+{
+  "tags": {
+    "previous": [
+      "introduction"
+    ],
+    "next": [
+      "contributing"
+    ]
+  },
+  "content": "# Documentation\n\n\n"
+}

package/content/models/documentation.md

@@ -0,0 +1,3 @@
+# Documentation
+
+

package/content/models/faq.json

@@ -0,0 +1,3 @@
+{
+  "content": "# FAQ"
+}

package/content/models/faq.md

@@ -0,0 +1 @@
+# FAQ

package/content/models/introduction.json

@@ -0,0 +1,8 @@
+{
+  "tags": {
+    "next": [
+      "documentation"
+    ]
+  },
+  "content": "# Introduction\n\n"
+}

package/content/models/introduction.md

@@ -0,0 +1,2 @@
+# Introduction
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/guide",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Hestia Guide pages",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/envs/.dev.env

@@ -1,2 +0,0 @@
-export BUCKET='hestia-dev-guide'
-export DISTRIB_ID='E3393LZT5IR3TE'

package/envs/.develop.env

@@ -1,2 +0,0 @@
-export BUCKET='hestia-staging-guide'
-export DISTRIB_ID='ELURHKMA1X6F1'

package/envs/.master.env

@@ -1,2 +0,0 @@
-export BUCKET='hestia-prod-guide'
-export DISTRIB_ID='E3HOSZSTUYX9WN'

package/scripts/build-content.js

@@ -1,54 +0,0 @@
-const { writeFileSync } = require("fs");
-const { join } = require("path");
-
-const {
-  mkdirs,
-  encoding,
-  srcDir,
-  listContent,
-  readContent,
-  removeContentTags,
-  getTags,
-} = require("./utils");
-
-const outputDir = join(__dirname, "..", "content");
-
-mkdirs(outputDir);
-
-const destFilename = (filename) =>
-  `${outputDir}/${filename.replace(srcDir, "").replace(/[\d]+_/g, "")}`;
-
-const buildMarkdownContent = (filename) => {
-  const content = readContent(filename, true);
-  const dest = destFilename(filename);
-  mkdirs(dest);
-  writeFileSync(dest, content, encoding);
-  return filename;
-};
-
-const buildJSONContent = (filename) => {
-  const content = readContent(filename, false);
-  const tags = getTags(content);
-  const dest = destFilename(filename).replace(".md", ".json");
-  mkdirs(dest);
-  writeFileSync(
-    dest,
-    JSON.stringify(
-      {
-        tags,
-        content: removeContentTags(content),
-      },
-      null,
-      2
-    ),
-    encoding
-  );
-  return filename;
-};
-
-const build = () => {
-  const files = listContent();
-  return files.map(buildMarkdownContent).map(buildJSONContent);
-};
-
-build();

package/scripts/build-index.js

@@ -1,91 +0,0 @@
-const { writeFileSync, readdirSync } = require("fs");
-const { join } = require("path");
-const { getStamps } = require("git-date-extractor");
-
-const {
-  encoding,
-  ROOT,
-  srcDir,
-  mkdirs,
-  contentDir,
-  isDir,
-  listContent,
-  readContent,
-  contentUrl,
-  getTitle,
-  getTags,
-} = require("./utils");
-
-const outputDir = join(__dirname, "..", "content");
-
-mkdirs(outputDir);
-
-const fileData = (stamps, filename) => {
-  const { created, modified } = stamps[join(contentDir, filename)];
-  const content = readContent(filename);
-  const lines = content.split("\n").filter(Boolean);
-  const title = getTitle(lines[0]);
-  const tags = getTags(content);
-  const filepath = filename.replace(/^[/]/g, "").replace(/[\d]+_/g, "");
-  const id = filepath
-    .replace(".md", "")
-    .replace(/\//g, "-")
-    .replace("-content", "");
-  return {
-    id,
-    mdPath: filepath,
-    jsonPath: filepath.replace(".md", ".json"),
-    title,
-    createdAt: new Date(created * 1000).toJSON(),
-    updatedAt: new Date(modified * 1000).toJSON(),
-    tags,
-  };
-};
-
-const folderData = (stamps, folder) => {
-  const pages = listContent(join(srcDir, folder)).filter(
-    (f) => !f.endsWith("0_content.md")
-  );
-  return {
-    content: fileData(stamps, join(folder, "0_content.md")),
-    ...(pages.length
-      ? {
-          pages: Object.fromEntries(
-            pages
-              .map((f) => f.replace(srcDir, ""))
-              .map((filename) => [
-                contentUrl(filename),
-                { content: fileData(stamps, filename) },
-              ])
-          ),
-        }
-      : {}),
-  };
-};
-
-const run = async () => {
-  const stamps = await getStamps({
-    projectRootPath: ROOT,
-  });
-
-  // keep the folder structure
-  const folders = readdirSync(srcDir).filter((f) => isDir(join(srcDir, f)));
-  const data = folders.map((folder) => [folder, folderData(stamps, folder)]);
-  const pages = Object.fromEntries(data);
-  const content = {
-    pages,
-  };
-
-  writeFileSync(
-    join(outputDir, "index.json"),
-    JSON.stringify(content, null, 2),
-    encoding
-  );
-};
-
-run()
-  .then(() => process.exit(0))
-  .catch((err) => {
-    console.error(err);
-    process.exit(1);
-  });

package/scripts/build.js

@@ -1,57 +0,0 @@
-const { existsSync, copyFileSync, unlinkSync, writeFileSync } = require("fs");
-const { join } = require("path");
-
-const {
-  mkdirs,
-  encoding,
-  srcDir,
-  listContent,
-  readContent,
-} = require("./utils");
-
-const outputDir = join(__dirname, "..", "www");
-
-mkdirs(outputDir);
-
-const copyFile = (src, dest) => {
-  existsSync(dest) && unlinkSync(dest);
-  mkdirs(dest);
-  copyFileSync(src, dest);
-};
-
-const copyTemplates = (folder) => {
-  mkdirs(folder);
-  ["template.css", "template.html", "template.js"].map((v) =>
-    copyFile(join(__dirname, v), join(folder, v.replace("template", "index")))
-  );
-};
-
-const buildContent = (filename) => {
-  const destFolder = join(outputDir, filename.replace(".md", ""));
-  copyTemplates(destFolder);
-
-  const content = readContent(filename, true);
-
-  writeFileSync(join(destFolder, "content.md"), content, encoding);
-};
-
-const generateIndex = (files) => {
-  copyTemplates(outputDir);
-  const content = `
-# Table of Contents
-
-${files
-  .map((f) => f.replace(".md", ""))
-  .map((f) => `- [${f}](./${f})`)
-  .join("\n\n")}
-  `.trim();
-  writeFileSync(join(outputDir, "content.md"), content, encoding);
-};
-
-const build = () => {
-  const files = listContent().map((f) => f.replace(srcDir, ""));
-  generateIndex(files);
-  return files.map(buildContent);
-};
-
-build();

package/scripts/check-content.js

@@ -1,80 +0,0 @@
-const {
-  listContent,
-  readContent,
-  isTag,
-  listAssets,
-  baseAssetRef,
-} = require("./utils");
-
-const allAssets = listAssets();
-
-const checkFilename = (filename) =>
-  filename
-    .split("/")
-    .pop()
-    .replace(".md", "")
-    .match(/^[\d]_[a-z\d\-]+$/g);
-
-const isValidLinks = (url) => !url.match(/\s/g) && !!new URL(url)?.host;
-
-const getUrls = (content) =>
-  (content.match(/href="([^"]*)/g) || []).map((v) => v.replace('href="', ""));
-
-const checkAssets = (content) => {
-  const urls = (content.match(/src="([^"]*)/g) || []).map((v) =>
-    v.replace(`src="${baseAssetRef}`, "")
-  );
-  const invalid = urls.filter((v) => !allAssets.includes(v));
-  if (invalid.length > 0) {
-    console.error(
-      "Invalid referenced assets",
-      invalid.map((v) => `${baseAssetRef}${v}`)
-    );
-  }
-  return invalid.length === 0;
-};
-
-const checks = {
-  'File should start with "# "': (content) => content.startsWith("# "),
-  "Links must be valid": (content) => getUrls(content).every(isValidLinks),
-  "Links must not point to staging website": (content) =>
-    [
-      "http://www-staging.hestia.earth",
-      "https://www-staging.hestia.earth",
-    ].every((v) => !content.includes(v)),
-  'Images and videos must be included in the "src/assets" folder': checkAssets,
-};
-
-const checkContent = (filename) => {
-  const content = readContent(filename);
-  return [
-    checkFilename(filename)
-      ? ""
-      : "File names must contain lowercase letters, numbers or dashes only, and start with a number followed by an underscore for sorting.",
-    ...Object.entries(checks)
-      .filter(([key, value]) => !value(content))
-      .map(([key, value]) => key),
-  ].filter(Boolean);
-};
-
-const run = () => {
-  const files = listContent();
-  const allErrors = files
-    .map((f) => ({
-      f,
-      errors: checkContent(f),
-    }))
-    .filter(({ errors }) => errors.length);
-
-  if (allErrors.length) {
-    allErrors.map(({ f, errors }) => {
-      console.error("Error in", f, ":");
-      errors.map((e) => console.error(`\t- ${e}`));
-    });
-    process.exit(1);
-  } else {
-    process.exit(0);
-  }
-};
-
-run();

package/scripts/template.css

@@ -1,6 +0,0 @@
-#main {
-  height: 100%;
-  width: 100%;
-  padding: 20px;
-  overflow: hidden;
-}

package/scripts/template.html

@@ -1,22 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-  <title>Markdown Preview</title>
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-
-  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/marked/4.2.1/marked.min.js"></script>
-
-  <link rel="stylesheet" href="https://cdn.hestia.earth/prod/styles.css">
-  <link rel="stylesheet" href="index.css">
-</head>
-<body>
-  <noscript>Please enable JavaScript to continue using this application.</noscript>
-
-  <a href="../"><< Back to index</a>
-
-  <div id="main"></div>
-
-  <script type="text/javascript" src="index.js"></script>
-</body>
-</html>

package/scripts/template.js

@@ -1,5 +0,0 @@
-fetch('content.md')
-  .then((response) => response.text())
-  .then((text) => {
-    document.getElementById('main').innerHTML = marked.parse(text);
-  });

package/scripts/utils.js

@@ -1,117 +0,0 @@
-const {
-  readdirSync,
-  readFileSync,
-  lstatSync,
-  existsSync,
-  mkdirSync,
-} = require("fs");
-const { join, resolve, parse } = require("path");
-
-const encoding = "utf8";
-const ROOT = resolve(join(__dirname, ".."));
-const contentDir = join("src", "content");
-const srcDir = join(ROOT, contentDir);
-const assetDir = join(ROOT, "src", "assets");
-
-const isDir = (path) => {
-  try {
-    return lstatSync(path).isDirectory();
-  } catch (_err) {
-    return false;
-  }
-};
-
-const mkdirs = (folder) =>
-  !existsSync(parse(folder).dir) &&
-  mkdirSync(parse(folder).dir, { recursive: true });
-
-const unique = (values) =>
-  values.some((v) => typeof v === "object")
-    ? [...new Set(values.map((v) => JSON.stringify(v)))].map((v) =>
-        JSON.parse(v)
-      )
-    : [...new Set(values)];
-
-const baseAssetRef = "/guide-content/assets";
-const listAssets = (directory = assetDir) =>
-  readdirSync(directory)
-    .flatMap((path) =>
-      isDir(join(directory, path))
-        ? listAssets(join(directory, path))
-        : !path.startsWith(".")
-        ? join(directory, path)
-        : null
-    )
-    .filter(Boolean)
-    .map((v) => v.replace(assetDir, ""));
-
-const listContent = (directory = srcDir) =>
-  readdirSync(directory)
-    .flatMap((path) =>
-      isDir(join(directory, path))
-        ? listContent(join(directory, path))
-        : !path.startsWith(".")
-        ? join(directory, path)
-        : null
-    )
-    .filter(Boolean)
-    .filter((f) => f.endsWith(".md"));
-const contentPath = (filename) =>
-  filename.includes(srcDir) ? filename : join(srcDir, filename);
-const contentUrl = (filename) =>
-  filename
-    .replace(/\//g, "-")
-    .substring(1)
-    .replace(/[\d]+_/g, "")
-    .replace(".md", "");
-const readContent = (filename, removeTags = false) => {
-  const content = readFileSync(contentPath(filename), encoding).trim();
-  return removeTags ? removeContentTags(content) : content;
-};
-const getTitle = (value) => value.replace("# ", "");
-
-const removeContentTags = (content) =>
-  content.replace(/\/[a-z]+\s\~(.*)\~/g, "");
-const isTag =
-  (key = "tag") =>
-  (value) =>
-    value.startsWith(`/${key}`);
-const getTag =
-  (key = "tag") =>
-  (value) =>
-    value.replace(`/${key} `, "").replace(/\~/g, "");
-const getTags = (content) =>
-  content
-    .match(/\/([a-z]+)\s\~(.*)\~/g)
-    ?.map((v) => ({
-      key: v.split(" ")[0].trim().replace("/", ""),
-      value: v.split(" ")[1].trim().replace(/\~/g, ""),
-    }))
-    .reduce(
-      (prev, { key, value }) => ({
-        ...prev,
-        [key]: [...(prev[key] || []), value],
-      }),
-      {}
-    );
-
-module.exports = {
-  encoding,
-  ROOT,
-  contentDir,
-  srcDir,
-  isDir,
-  mkdirs,
-  unique,
-  listContent,
-  contentPath,
-  contentUrl,
-  readContent,
-  getTitle,
-  removeContentTags,
-  isTag,
-  getTag,
-  getTags,
-  listAssets,
-  baseAssetRef,
-};

package/test.js

@@ -1,4 +0,0 @@
-const { loadIndex, loadPage, findPage } = require("./dist/index");
-
-console.log(loadIndex());
-console.log(loadPage(findPage("models-introduction")));