@hestia-earth/guide 0.0.7 → 0.0.9

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.9](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.8...v0.0.9) (2024-10-30)
+
+
+### Features
+
+* start with header level 2 ([954721f](https://gitlab.com/hestia-earth/hestia-guide/commit/954721f1437679e110a8da7c0d6fff2539b91519))
+
+### [0.0.8](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.7...v0.0.8) (2024-10-30)
+
 ### [0.0.7](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.6...v0.0.7) (2024-10-29)
 
 ### [0.0.6](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.5...v0.0.6) (2024-10-29)

package/README.md

@@ -13,14 +13,14 @@ Note: only lower chars, dashes (`-`) and numbers are allowed in the filenames.
 ## Writing Guidelines
 
 1. Create a new file under `src/content` and make sure the filename only uses lowercase letters, numbers and dashes.
-1. Start the file with a header level 1 using a single `#`. Example:
+1. Start the file with a header level 2 using a double `##`. Example:
 
 ```markdown
-# This is the header
+## This is the header
 
 This is the content.
 
-## This is a sub-header
+### This is a sub-header
 ```
 
 The header level 1 will be automatically used as Title for the Guide page, so please try to keep it short.

package/dist/content/hestia-101/content.json

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

package/dist/content/index.json

@@ -1,33 +1,33 @@
 {
-  "pages": {
-    "hestia-101": {
+  "pages": [
+    {
       "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"
+        "title": "#HESTIA 101",
+        "createdAt": "2024-10-29T09:33:08.000Z",
+        "updatedAt": "2024-10-30T08:23:25.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"
+        "title": "#Applying Models",
+        "createdAt": "2024-10-29T09:33:08.000Z",
+        "updatedAt": "2024-10-30T08:23:25.000Z"
       },
-      "pages": {
-        "models-introduction": {
+      "pages": [
+        {
           "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",
+            "title": "#Introduction",
+            "createdAt": "2024-10-29T09:33:08.000Z",
+            "updatedAt": "2024-10-30T08:23:25.000Z",
             "tags": {
               "next": [
                 "documentation"
@@ -35,14 +35,14 @@
             }
           }
         },
-        "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",
+            "title": "#Documentation",
+            "createdAt": "2024-10-29T09:33:08.000Z",
+            "updatedAt": "2024-10-30T08:23:25.000Z",
             "tags": {
               "previous": [
                 "introduction"
@@ -53,14 +53,14 @@
             }
           }
         },
-        "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",
+            "title": "#Contributing",
+            "createdAt": "2024-10-29T09:33:08.000Z",
+            "updatedAt": "2024-10-30T08:23:25.000Z",
             "tags": {
               "previous": [
                 "documentation"
@@ -68,17 +68,17 @@
             }
           }
         },
-        "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"
+            "title": "#FAQ",
+            "createdAt": "2024-10-29T09:33:08.000Z",
+            "updatedAt": "2024-10-30T08:23:25.000Z"
           }
         }
-      }
+      ]
     }
-  }
+  ]
 }

package/dist/content/models/content.json

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

package/dist/content/models/contributing.json

@@ -4,5 +4,5 @@
       "documentation"
     ]
   },
-  "content": "# Contributing\n\n"
+  "content": "## Contributing\n\n"
 }

package/dist/content/models/documentation.json

@@ -7,5 +7,5 @@
       "contributing"
     ]
   },
-  "content": "# Documentation\n\n\n"
+  "content": "## Documentation\n\n\n"
 }

package/dist/content/models/faq.json

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

package/dist/content/models/introduction.json

@@ -4,5 +4,5 @@
       "documentation"
     ]
   },
-  "content": "# Introduction\n\n"
+  "content": "## Introduction\n\n"
 }

package/dist/index.d.ts

@@ -7,12 +7,9 @@ export interface IGuideIndexPageContent {
     updatedAt?: string;
     tags?: Record<string, string[]>;
 }
-type guidePages = {
-    [url: string]: IGuideIndexPage;
-};
 export interface IGuideIndexPage {
     content?: IGuideIndexPageContent;
-    pages?: guidePages;
+    pages?: IGuideIndexPage[];
 }
 export declare const loadIndex: () => IGuideIndexPage;
 export declare const listPages: () => IGuideIndexPageContent[];
@@ -22,4 +19,3 @@ export interface IGuidePageContent {
     tags?: Record<string, string[]>;
 }
 export declare const loadPage: ({ jsonPath }: IGuideIndexPageContent) => IGuidePageContent;
-export {};

package/package.json

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