verbose / verb-generate-readme

Generate your project's readme with verb. Requires verb v0.9.0 or higher.
MIT License
162 stars 17 forks source link

How to set data #8

Closed stefanwalther closed 8 years ago

stefanwalther commented 8 years ago

Hi,

how can I set custom config for e.g. twitter.username, I tried:

"verb": {
    "run": true,
    "toc": false,
    "data": {
      "twitter": {"username": "waltherstefan"}
    },
...

But this is not working as expected ...

Regards Stefan

jonschlinkert commented 8 years ago

It might just be "twitter": "waltherstefan", the rest of it looks correct

stefanwalther commented 8 years ago

Thx, works.

jonschlinkert commented 8 years ago

@stefanwalther btw, you were wondering about "the big picture", this might help. I'd still like to get together, I replied on gitter but I don't see those messages sometimes, so you probably didn't either.

if you check my profile my email address is there if you want to contact me directly so we can plan a day/time. thanks

stefanwalther commented 8 years ago

This is absolutely great, I will spend some time next week on that ;-) Very much looking forward to seeing everything working ...

stefanwalther commented 8 years ago

This is a game-changer for nodejs devs ...

jonschlinkert commented 8 years ago

thanks! we think so too! game-changer was the goal :)

Very much looking forward to seeing everything working ..

I've been struggling with getting all of the pieces documented, but now that I can describe how everything fits together, hopefully others will be able to help with it.

fwiw, most bugs or issues we experience at this point should be relatively minor, and will be eliminated through feedback and usage. the "hard part" is over :)

stefanwalther commented 8 years ago

hopefully others will be able to help with it

Count on me ...

most bugs or issues we experience at this point should be relatively minor

Couldn't get generate to work at all, non of the libs and generators, tested several node.js versions, none of them with success, but beside that:

So really great, just looking forward to get a bit more insight to leverage the full power of all these tools. Again, just great!

jonschlinkert commented 8 years ago

Couldn't get generate to work at all, non of the libs and generators, tested several node.js versions, none of them with success, but beside that:

Which generators? I completely reinstall generate and generators several times a day with no issues. Maybe there is something we're not explaining in the docs?

Can you try this, just to see if it works?

$ npm install --global generate generate-license

then run:

$ gen license

I also have some changes to push up. I'll try to do that in a bit

jonschlinkert commented 8 years ago

the same applies for verb

Oh good, have you been using the dev branch?

stefanwalther commented 8 years ago

reg verb: Yes, using the dev branch.

jonschlinkert commented 8 years ago

verb uses generate. if verb is working for you, I'm not sure why generate isn't working. verb-readme-generator is just a generate generator

stefanwalther commented 8 years ago

hmmm ;-)

stefanwalther commented 8 years ago

BTW, now works all like a glance ;-)

jonschlinkert commented 8 years ago

now works all like a glance ;-)

that's great! I'm going to merge verb into master as soon as I can get some docs finished for the readme.

stefanwalther commented 8 years ago

;-) Sorry, this drives me crazy, twitter customization is again not working and I cannot find it, still using "twitter": "waltherstefan" in the verb section of package.json, but not it does not work anymore. Any ideas?

Using verbose/verb#dev & verb-generate-readme from today.

jonschlinkert commented 8 years ago

Yeah it's driving me crazy too. The template is {%= author.twitter %}.

jonschlinkert commented 8 years ago

you can do a pr to verb-repo-data to normalize twitter onto author.twitter or something.

stefanwalther commented 8 years ago

OK, thx - will do. Just to get rid of this ;-)

jonschlinkert commented 8 years ago

Just to get rid of this ;-)

yeah, try to remember that you're using unreleased software. Verb 0.9.0 is in beta. You recently commented that assemble has been stable - that's because we released it when it was stable. Verb isn't. So these issues are probably more frustrating for me than you lol. I'm really excited and happy that you want to use the dev branch and provide helpful feedback, but it's time consuming to keep up with issues for something we haven't even released.

I don't think there is a "perfect scenario", we both just need to be fair minded about it and realize that we have to make compromises