@moonwave99/goffre 0.1.0 → 0.1.2

package/README.md

@@ -7,31 +7,31 @@ It uses [handlebars][handlebars] as templating system and [markdown + frontmatte
 ## Installation
 
 ```bash
-$ npm install goffre --save
+npm install @moonwave99/goffre --save
 ```
 
 ## Basic Usage
 
 ```js
-import { load, render } from "goffre";
+import { load, render } from "@moonwave99/goffre";
 
 (async () => {
-    const { pages } = await load();
-
-    try {
-        const results = await render({ pages });
-        console.log(`Generated ${results.length} pages`);
-    } catch (error) {
-        console.log("Error generating site", error);
-    }
+  const { pages } = await load();
+
+  try {
+    const results = await render({ pages });
+    console.log(`Generated ${results.length} pages`);
+  } catch (error) {
+    console.log("Error generating site", error);
+  }
 })();
 ```
 
 Default paths:
 
--   **markdown files**: `./data` - used by `load()`
--   **output folder**: `./dist` - used by `render()`
--   **handlebars views**: `./src/views` - used by `render()`
+- **markdown files**: `./data` - used by `load()`
+- **output folder**: `./dist` - used by `render()`
+- **handlebars views**: `./src/views` - used by `render()`
 
 See [examples](#examples) for a more advanced use case, and the [documentation][docs] for the complete reference.
 
@@ -66,18 +66,18 @@ The `render()` method writes then every incoming page to `{page.slug}.html` - yo
 ```js
 const { pages } = await load({ dataPath });
 const results = await render({
-    buildPath,
-    sitePath,
-    pages: [
-        ...pages,
-        {
-            title: "Goffre | Mini static site generator",
-            description:
-                "Goffre is a minimal static site generator available to the node.js ecosystem.",
-            slug: "index",
-            content: await readFile(path.join("..", "README.md"), "utf8"),
-        },
-    ],
+  buildPath,
+  sitePath,
+  pages: [
+    ...pages,
+    {
+      title: "Goffre | Mini static site generator",
+      description:
+        "Goffre is a minimal static site generator available to the node.js ecosystem.",
+      slug: "index",
+      content: await readFile(path.join("..", "README.md"), "utf8"),
+    },
+  ],
 });
 ```
 
@@ -97,11 +97,11 @@ The scripts of `package.json` will look more or less like:
 
 ```json
 {
-    "clean": "rm -rf dist",
-    "dev:client": "webpack serve --mode development",
-    "dev:site": "nodemon -e js,json,md,handlebars --watch index.js --watch data --watch src/views",
-    "build:client": "webpack --mode production",
-    "build:site": "node index.js"
+  "clean": "rm -rf dist",
+  "dev:client": "webpack serve --mode development",
+  "dev:site": "nodemon -e js,json,md,handlebars --watch index.js --watch data --watch src/views",
+  "build:client": "webpack --mode production",
+  "build:site": "node index.js"
 }
 ```
 
@@ -109,17 +109,15 @@ Just `npm run dev:client` and `npm run dev:site` in two terminal tabs and you ar
 
 ## Examples
 
--   [devblog][examples-devblog] - a personal website with blog posts and project pages
--   this page of course
+- [devblog][examples-devblog] - a personal website with blog posts and project pages
+- this page of course
 
 [handlebars]: https://handlebarsjs.com/
-[express-handlebars]: https://www.npmjs.com/package/express-handlebars
 [mdfront]: https://www.google.com/search?q=markdown+frontmatter
 [webpack]: https://webpack.js.org/
 [webpack-dev-server]: https://webpack.js.org/configuration/dev-server/
 [http-server]: https://www.npmjs.com/package/http-server
 [nodemon]: https://www.npmjs.com/package/nodemon
-[example]: https://github.com/moonwave99/goffre/tree/main/examples/devblog
 [docs]: https://github.com/moonwave99/goffre/tree/main/examples/devblog
 [webpack-config]: https://github.com/moonwave99/goffre/blob/main/homepage/webpack.config.cjs
 [examples-devblog]: https://goffre-examples-devblog.netlify.app/

package/dist/index.d.ts

@@ -1,5 +1,44 @@
 import { MarkedExtension, RendererObject } from 'marked';
+import { HelperOptions } from 'handlebars';
 
+type Context = {
+    data: {
+        root: {
+            options?: {
+                domain?: string;
+                env?: {
+                    mode?: string;
+                };
+            };
+        };
+    };
+};
+type HelperContext = Context & Omit<HelperOptions, "fn" | "inverse">;
+type BlockContext = Context & HelperOptions;
+declare const markdown: (text: string) => string | Promise<string>;
+declare const getParamLink: (url: string, options: HelperContext) => string;
+declare const getAsset: (asset: string, context: Omit<HelperContext, "hash">) => string;
+declare const getSitemapLink: (page: Page, context: HelperContext) => string;
+declare const getLink: (page: Page, context: HelperContext) => string;
+declare const getNavClass: ({ slug }: Page, currentPage: Page) => string;
+declare const list: (context: Page[], options: BlockContext) => string;
+declare const nextItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
+declare const prevItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
+
+declare const defaultHelpers_getAsset: typeof getAsset;
+declare const defaultHelpers_getLink: typeof getLink;
+declare const defaultHelpers_getNavClass: typeof getNavClass;
+declare const defaultHelpers_getParamLink: typeof getParamLink;
+declare const defaultHelpers_getSitemapLink: typeof getSitemapLink;
+declare const defaultHelpers_list: typeof list;
+declare const defaultHelpers_markdown: typeof markdown;
+declare const defaultHelpers_nextItem: typeof nextItem;
+declare const defaultHelpers_prevItem: typeof prevItem;
+declare namespace defaultHelpers {
+  export { defaultHelpers_getAsset as getAsset, defaultHelpers_getLink as getLink, defaultHelpers_getNavClass as getNavClass, defaultHelpers_getParamLink as getParamLink, defaultHelpers_getSitemapLink as getSitemapLink, defaultHelpers_list as list, defaultHelpers_markdown as markdown, defaultHelpers_nextItem as nextItem, defaultHelpers_prevItem as prevItem };
+}
+
+declare const helpers: typeof defaultHelpers;
 type Page = {
     slug: string;
     link?: string;
@@ -80,4 +119,4 @@ type PaginatedResult<T extends Page> = {
 };
 declare function paginate<T extends Page>({ collection, size, sortBy, order, }: PaginateParams<T>): PaginatedResult<T>[];
 
-export { type Page, getSlug, getSorter, getTemplate, load, loadJSON, loadMarkdown, paginate, render };
+export { type Page, getSlug, getSorter, getTemplate, helpers, load, loadJSON, loadMarkdown, paginate, render };

package/dist/index.js

@@ -94,6 +94,7 @@ var prevItem = (context, options) => {
 };
 
 // lib/goffre.ts
+var helpers = helpers_exports;
 var require2 = createRequire(import.meta.url);
 var { readFile, outputFile } = fs;
 var DEFAULT_DATA_PATH = path.join(process.cwd(), "data");
@@ -387,6 +388,7 @@ export {
   getSlug,
   getSorter,
   getTemplate,
+  helpers,
   load,
   loadJSON,
   loadMarkdown,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moonwave99/goffre",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Mini static site generator",
   "author": {
     "name": "Diego Caponera",