https://github.com/i78/hugo-query
Information Extractor from Hugo Frontmatter content
https://github.com/i78/hugo-query
frontmatter g go hugo
Last synced: 5 months ago
JSON representation
Information Extractor from Hugo Frontmatter content
- Host: GitHub
- URL: https://github.com/i78/hugo-query
- Owner: i78
- Created: 2020-03-19T11:45:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-27T15:31:57.000Z (almost 3 years ago)
- Last Synced: 2024-11-15T12:09:43.682Z (over 1 year ago)
- Topics: frontmatter, g, go, hugo
- Language: Go
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hugo-Query
Hugo-Query extracts content from a Hugo content folder structure.
## Fields of application
hugo-query is supposed to be used in release pipeline steps for extracting content from the raw .md markdown files in applications where it is not feasible to obtain the wanted data from another source.
# Examples
## Extract eMail addresses from a user list
I created hugo-query to extract a whitelist of email addresses from a team list, with one page per individual containing a members email address in a frontmatter field named "email". The whitelist is generated in a pipeline step before the hugo public folder is uploaded to the target server.
Given a tree of Markdown files with a header named "email":
```
+++
title = "Alice Bob"
type = "member"
country = "norway"
email = "sendmeallyourspam@example.com"
+++
Lorem Ipsum dolor set amet ..
```
.. one can extract the email field as a json map as follows:
```
hugo-query extract --content-folder my-hug-site/content --content-type member --field email --pretty
```
Output:
```
{
"Alice Bob": {
"email": "sendmeallyourspam@example.com"
}
}
```
It is also possible to extract multiple fields:
```
hugo-query extract --content-folder my-hug-site/content --content-type member --field email --field country --pretty
```
Output:
```
{
"Alice Bob": {
"email": "sendmeallyourspam@example.com",
"country": "norway"
}
}
```
## Code of Conduct
This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters.
For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage.