contentful-hugo - npm Package Compare versions

Comparing version 1.3.4 to 1.3.6

package.json

 {
   "name": "contentful-hugo",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "description": "Node module that pulls data from Contentful and turns it into markdown files for Hugo. Can be used with other Static Site Generators, but has some Hugo specific features.",
@@ -5,0 +5,0 @@ "main": "index.js",

readme.md

@@ -12,3 +12,3 @@ # Contentful Hugo
 - [Expected Output](#Expected-Output)
-- [Compatibility Issues](#Compatibility-Issues)
+- [Known Issues](#Known-Issues)
 
@@ -32,9 +32,34 @@
 
-Complete [configuration](#configuration) then run the following command in the terminal
+Complete [configuration](#configuration) then run the following command(s) in the terminal
 
+## When Installed Globally
+
 ```
 contentful-hugo
 ```
-Failure to complete configuration will return an error in the console
 
+## When Installed Locally
+```
+npx contentful-hugo
+```
+
+## Example Package-JSON
+
+```JSON
+{
+  "name": "my-hugo-project",
+  "scripts": {
+    "prestart": "contentful-hugo",
+    "start": "hugo server",
+    "prebuild": "contentful-hugo",
+    "build": "hugo --minify"
+  }
+}
+```
+In this example when you run `npm start` it will first use contentful-hugo to pull Contentful data then start hugo server. In the same way when you do the command `npm run build` it will first use contentful-hugo to pull Contentful data then run `hugo --minify` to build a minified version of your hugo site.
+
+## Error Messages
+
+Trying to use this package before completing configuration will return an error in the console
+
 ![Environment Variables not set](https://raw.githubusercontent.com/ModiiMedia/contentful-hugo/master/images/environment-variables-missing.jpg)
@@ -245,6 +270,7 @@
 
-# Compatibility Issues
+# Known Issues
 
-These are know compatibility issues.
+These are some known issues.
 
-- Hugo cannot parse date field if field is set to "date and time without timezone"
+- **Date & Time Field w/o Timezone**: Hugo cannot parse date field if field is set to "date and time without timezone"
+- **Fetching Data Before Contentful CDN Updates**: Sometimes when triggering a build from a webhook, it won't always get the latest data. This is because it sometimes takes a couple seconds for the latest data to get distrubuted across Contentful's CDN. If you run into this issue it might be worth it to create a "wait function" just to delay fetching the data by a couple seconds. You could include it in the script you use contentful-hugo by doing something like the following ```"node wait.js && contentful-hugo"```

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

73924

increased by1.66%

Number of lines in readme file

273

increased by10.53%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes