Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipes section needs more introduction material #2461

Open
chrillek opened this issue Mar 1, 2024 · 1 comment
Open

Pipes section needs more introduction material #2461

chrillek opened this issue Mar 1, 2024 · 1 comment

Comments

@chrillek
Copy link

chrillek commented Mar 1, 2024

Currently, the only explanation is
Hugo Pipes is Hugo’s asset processing set of functions.
It would be helpful to mention what an "asset" could be, and also that they are located under the assets directory. The latter might be self-evident for people already familiar with Hugo. But not for newbies.

Something along the lines of

Pipes allow you to process files under the `assets` folder in various ways. For example
- transform SASS files into CSS
- Bundle and transform JavaScript files
- …
These files are accessed through the `Resource` object, which can refer to local or remote files.

Such an introduction would make it (I think) clearer why pipes are relevant and what they can be used for, thus enticing people to continue learning about them.

@jmooring
Copy link
Member

jmooring commented Mar 1, 2024

This entire section needs to be reworked, pointing to the relevant method pages instead of duplicating the examples. I'm not even sure it needs to be its own section, but that needs some thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants