Skip to content
This repository has been archived by the owner on Aug 21, 2023. It is now read-only.

Spread the word #3

Open
tomek-he-him opened this issue Jun 24, 2015 · 6 comments
Open

Spread the word #3

tomek-he-him opened this issue Jun 24, 2015 · 6 comments

Comments

@tomek-he-him
Copy link
Contributor

@ChiperSoft @trusktr what do you guys think? Do we need this thing?

@trusktr
Copy link

trusktr commented Jun 24, 2015

@tomekwi Cool! This definitely makes the CLI easier to use. I was using the dox programmatically, so I didn't use the CLI. I skipped the CLI for that reason. hehe.

@tomek-he-him
Copy link
Contributor Author

I was using the dox programmatically, so I didn't use the CLI. I skipped the CLI for that reason. hehe.

Yeah, same with me :) But that usually meant writing a doc generation script for every project.

So I’m now working on a generic, flexible tool named doxie – targeting CLI usage. Drop a short npm script into your package.json and you’re off. Tweak and polish your docs to the last detail – or take a ready-made preset.

@trusktr
Copy link

trusktr commented Jun 24, 2015

Aah, cool! Got a sample repo that uses doxie to make docs?

@tomek-he-him
Copy link
Contributor Author

Not yet :) It’s everything a work in progress :) But I’ll keep you updated.

@tomek-he-him
Copy link
Contributor Author

Right @trusktr now there are a couple of examples in the wild: https://github.com/studio-b12/doxie/tree/8c9150d#made-with-doxie.

One of them is this repo itself! :) Check it out: https://github.com/studio-b12/polydox/blob/c7d9c09/package.json#L17.

@trusktr
Copy link

trusktr commented Jul 20, 2015

The output is ****ing amazing.

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

No branches or pull requests

2 participants