Improve docs

[sindresorhus]

• Document CLI more than just a --help dump. Do a tutorial or something
• Document the keywords that can be used instead of sizes. Document keywords kevva/viewport-list#2

Feedback welcome on what else.

[jensgro]

Hi Sindre,

I would be interested in the documentation of the grunt-task (!) to see how to capture multiple pages with multiple sizes. And if I could capture only fragments of a page, selecting with a css-selector.

[sindresorhus]

to see how to capture multiple pages with multiple sizes

Done, but it really is just basic grunt config and nothing specifically to do with grunt-pageres though.

sindresorhus/grunt-pageres@4eeeed9

And if I could capture only fragments of a page, selecting with a css-selector.

That's not supported, but I created a ticket for it: #100

[jensgro]

That was superfast. Thanks a lot.

[kevva]

@jensgro, fyi, we've added support for capturing DOM elements.

[jensgro]

Hi kevva,

I am happy to hear/read that. I updates pageres and tested the new option with grunt-pageres but I have the impression, that this new optiion has to be integrated there, too. I couldn't make screenshots of page-areas. But I am looking forward the integration of this new feature into the grunt-task.

[sindresorhus]

@jensgro it hasn't been released yet: https://github.com/sindresorhus/pageres/milestones

[boo1ean]

@sindresorhus what about documenting programmatic API? and probably improving a little programmatic API 🌛

[kevva]

@boo1ean, https://github.com/sindresorhus/pageres#usage-1.

[boo1ean]

@kevva guess I've missed it (－‸ლ)
Thanks!

[AllenSH12]

I've expanded on the CLI docs a little here: https://github.com/AllenSH12/pageres#usage

Nothing too drastic but I think it's a step in the right direction. Anyone care to take a look and maybe make some suggestions before I make a PR?

[kevva]

That's too verbose imo. I think using the CLI help output is fine in the readme or else it'll be a long wall of text that nobody reads. But yeah, might link to a tutorial or likewise.

[dt0818]

Default Vogel gbnf

Sent from my iPhone

On Oct 16, 2014, at 23:22, Allen Hernandez notifications@github.com wrote:

I've expanded on the CLI docs a little here: https://github.com/AllenSH12/pageres#usage

Nothing too drastic but I think it's a step in the right direction. Anyone care to take a look and maybe make some suggestions before I make a PR?

—
Reply to this email directly or view it on GitHub.

[sindresorhus]

@AllenSH12 I like it. The current clone of the CLI help is there just because I'm lazy. Can you do a PR? Easier to give feedback on a PR.

@kevva I would generally agree, but this tool is used by a lot of CLI beginners eg. designers which could use a bit more handholding, and I've been wanting to make to improve the CLI docs. After this we can probably slim down the usage/examples in the cli help and instead refer here for more docs.

[AllenSH12]

Have submitted the PR here: #131

[kevva]

Fixed in c791708.