vuepress-plugin-frontmatter-update-info

# Demo: S3

# How ?

This demo plugin uses Amazon S3.
To demonstrate, it collects update info when ready() hook was executed.

See demo plugin code (opens new window).

# Configuration

# Local site

Copy config.example.js and create config.local.js.

S3 object key: vuepress-plugin-frontmatter-update-info.demo.s3.local.json

# Production site

Register env variables:

  • S3_CONFIGURED (Set true to activate)
  • S3_REGION
  • S3_ACCESS_KEY_ID
  • S3_SECRET_ACCESS_KEY
  • S3_BUCKET

S3 object key: vuepress-plugin-frontmatter-update-info.demo.s3.gh.json

See also GitHub Actions configuration (opens new window) of this demo site.

# Demo

Diff of current and previous generations (based on date)

Using DiffStyleDate (opens new window)

Records are extracted if:

  • The date is new one in current generation.
[]

Diff of current and previous generations (based on date and description)

Using DiffStyleDateDescription (opens new window)

Records are extracted if:

  • The date is new one in current generation, or
  • The date is not new but the description was modified.
[]

Update info of current and previous generations

Stored on Amazon S3.

  • generation_0: current
  • generation_1: previous
{
  "generation_0": [
    {
      "key": "v-0467e7f7",
      "path": "/pages/basic_01.html",
      "title": "Basic 01",
      "dateFirst": "2023/04/28",
      "dateLast": "2023/04/28",
      "records": [
        {
          "date": "2023/04/28",
          "description": [
            "Update text (modified)."
          ]
        }
      ],
      "recordsHash": "91276660",
      "option": {}
    },
    {
      "key": "v-021e4f75",
      "path": "/pages/basic_02.html",
      "title": "Basic 02",
      "dateFirst": "2022/09/20",
      "dateLast": "2023/04/25",
      "records": [
        {
          "date": "2022/09/20",
          "description": [
            "Update text (modified)."
          ]
        },
        {
          "date": "2023/04/25",
          "description": [
            "Update text."
          ]
        }
      ],
      "recordsHash": "41fe1fc8",
      "option": {}
    },
    {
      "key": "v-0056921a",
      "path": "/pages/page003.html",
      "title": "Basic 03",
      "dateFirst": "2022/08/05",
      "dateLast": "2022/08/11",
      "records": [
        {
          "date": "2022/08/05",
          "description": []
        },
        {
          "date": "2022/08/11",
          "description": []
        }
      ],
      "recordsHash": "79478d96",
      "option": {}
    },
    {
      "key": "v-04e9c31e",
      "path": "/pages/basic_04.html",
      "title": "Basic 04",
      "dateFirst": "2022/09/15",
      "dateLast": "2022/09/15",
      "records": [
        {
          "date": "2022/09/15",
          "description": [
            "Lorem ipsum dolor sit amet."
          ]
        }
      ],
      "recordsHash": "bf1d0878",
      "option": {}
    },
    {
      "key": "v-097cf422",
      "path": "/pages/basic_05.html",
      "title": "Basic 05",
      "dateFirst": "2022/09/01",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information.",
            "Update information."
          ]
        }
      ],
      "recordsHash": "81b80a10",
      "option": {}
    },
    {
      "key": "v-0e102526",
      "path": "/pages/basic_06.html",
      "title": "Basic 06",
      "dateFirst": "2023/05/11",
      "dateLast": "2023/05/11",
      "records": [
        {
          "date": "2023/05/11",
          "description": [
            "Update information.",
            "Update information."
          ]
        }
      ],
      "recordsHash": "e8079890",
      "option": {
        "page_embed": false
      }
    },
    {
      "key": "v-162424a5",
      "path": "/pages/custom_tag_01.html",
      "title": "Custom tag 01",
      "dateFirst": "2022/09/01",
      "dateLast": "2022/09/02",
      "records": [
        {
          "date": "2022/09/02",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "75925262",
      "option": {}
    },
    {
      "key": "v-4128e1c5",
      "path": "/pages/custom_tag_02.html",
      "title": "Custom tag 02",
      "dateFirst": "2022/09/13",
      "dateLast": "2022/09/13",
      "records": [
        {
          "date": "2022/09/13",
          "description": [
            "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
          ]
        }
      ],
      "recordsHash": "242d0f00",
      "option": {}
    },
    {
      "key": "v-6c2d9ee5",
      "path": "/pages/custom_tag_03.html",
      "title": "Custom tag 03",
      "dateFirst": "2022/08/31",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/08/31",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "f45dcb2a",
      "option": {}
    },
    {
      "key": "v-62ecdfff",
      "path": "/pages/invalid_06.html",
      "title": "Invalid 06",
      "dateFirst": "2022/07/11",
      "dateLast": "2022/07/11",
      "records": [
        {
          "date": "2022/07/11",
          "description": [
            "Update text for 2022/07/11."
          ]
        }
      ],
      "recordsHash": "cab6d35e",
      "option": {}
    },
    {
      "key": "v-667b0bbd",
      "path": "/pages/invalid_07.html",
      "title": "Invalid 07",
      "dateFirst": "2022/08/31",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/08/31",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "f45dcb2a",
      "option": {}
    },
    {
      "key": "v-6a09377b",
      "path": "/pages/invalid_08.html",
      "title": "Invalid 08",
      "dateFirst": "2023/05/01",
      "dateLast": "2023/05/01",
      "records": [
        {
          "date": "2023/05/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "6d59cca4",
      "option": {}
    },
    {
      "key": "v-6d976339",
      "path": "/pages/invalid_09.html",
      "title": "Invalid 09",
      "dateFirst": "2023/05/01",
      "dateLast": "2023/05/01",
      "records": [
        {
          "date": "2023/05/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "6d59cca4",
      "option": {}
    }
  ],
  "generation_1": [
    {
      "key": "v-0467e7f7",
      "path": "/pages/basic_01.html",
      "title": "Basic 01",
      "dateFirst": "2023/04/28",
      "dateLast": "2023/04/28",
      "records": [
        {
          "date": "2023/04/28",
          "description": [
            "Update text."
          ]
        }
      ],
      "recordsHash": "5da6f44c",
      "option": {}
    },
    {
      "key": "v-021e4f75",
      "path": "/pages/basic_02.html",
      "title": "Basic 02",
      "dateFirst": "2022/09/20",
      "dateLast": "2023/04/25",
      "records": [
        {
          "date": "2022/09/20",
          "description": [
            "Update text (modified)."
          ]
        },
        {
          "date": "2023/04/25",
          "description": [
            "Update text."
          ]
        }
      ],
      "recordsHash": "41fe1fc8",
      "option": {}
    },
    {
      "key": "v-0056921a",
      "path": "/pages/page003.html",
      "title": "Basic 03",
      "dateFirst": "2022/08/05",
      "dateLast": "2022/08/11",
      "records": [
        {
          "date": "2022/08/05",
          "description": []
        },
        {
          "date": "2022/08/11",
          "description": []
        }
      ],
      "recordsHash": "79478d96",
      "option": {}
    },
    {
      "key": "v-04e9c31e",
      "path": "/pages/basic_04.html",
      "title": "Basic 04",
      "dateFirst": "2022/09/15",
      "dateLast": "2022/09/15",
      "records": [
        {
          "date": "2022/09/15",
          "description": [
            "Lorem ipsum dolor sit amet."
          ]
        }
      ],
      "recordsHash": "bf1d0878",
      "option": {}
    },
    {
      "key": "v-097cf422",
      "path": "/pages/basic_05.html",
      "title": "Basic 05",
      "dateFirst": "2022/09/01",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information.",
            "Update information."
          ]
        }
      ],
      "recordsHash": "81b80a10",
      "option": {}
    },
    {
      "key": "v-0e102526",
      "path": "/pages/basic_06.html",
      "title": "Basic 06",
      "dateFirst": "2023/05/10",
      "dateLast": "2023/05/10",
      "records": [
        {
          "date": "2023/05/10",
          "description": [
            "Update information.",
            "Update information."
          ]
        }
      ],
      "recordsHash": "8a45a858",
      "option": {
        "page_embed": false
      }
    },
    {
      "key": "v-162424a5",
      "path": "/pages/custom_tag_01.html",
      "title": "Custom tag 01",
      "dateFirst": "2022/09/01",
      "dateLast": "2022/09/02",
      "records": [
        {
          "date": "2022/09/02",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "75925262",
      "option": {}
    },
    {
      "key": "v-4128e1c5",
      "path": "/pages/custom_tag_02.html",
      "title": "Custom tag 02",
      "dateFirst": "2022/09/13",
      "dateLast": "2022/09/13",
      "records": [
        {
          "date": "2022/09/13",
          "description": [
            "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
          ]
        }
      ],
      "recordsHash": "242d0f00",
      "option": {}
    },
    {
      "key": "v-6c2d9ee5",
      "path": "/pages/custom_tag_03.html",
      "title": "Custom tag 03",
      "dateFirst": "2022/08/31",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/08/31",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "f45dcb2a",
      "option": {}
    },
    {
      "key": "v-62ecdfff",
      "path": "/pages/invalid_06.html",
      "title": "Invalid 06",
      "dateFirst": "2022/07/11",
      "dateLast": "2022/07/11",
      "records": [
        {
          "date": "2022/07/11",
          "description": [
            "Update text for 2022/07/11."
          ]
        }
      ],
      "recordsHash": "cab6d35e",
      "option": {}
    },
    {
      "key": "v-667b0bbd",
      "path": "/pages/invalid_07.html",
      "title": "Invalid 07",
      "dateFirst": "2022/08/31",
      "dateLast": "2022/09/01",
      "records": [
        {
          "date": "2022/09/01",
          "description": [
            "Update information."
          ]
        },
        {
          "date": "2022/08/31",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "f45dcb2a",
      "option": {}
    },
    {
      "key": "v-6a09377b",
      "path": "/pages/invalid_08.html",
      "title": "Invalid 08",
      "dateFirst": "2023/05/01",
      "dateLast": "2023/05/01",
      "records": [
        {
          "date": "2023/05/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "6d59cca4",
      "option": {}
    },
    {
      "key": "v-6d976339",
      "path": "/pages/invalid_09.html",
      "title": "Invalid 09",
      "dateFirst": "2023/05/01",
      "dateLast": "2023/05/01",
      "records": [
        {
          "date": "2023/05/01",
          "description": [
            "Update information."
          ]
        }
      ],
      "recordsHash": "6d59cca4",
      "option": {}
    }
  ]
}

← Demo: S3 + Slack →