Wanted to find a project to play around with VuePress and figured i'd help improve the documentation for this library since i use it on a regular basis (thanks @Marak)
Anyways, I'm almost done with the full documentation and thought i would share it with the community.
You can access the documentation here: https://fakerjsdocs.netlify.com/
Repo is here: https://github.com/JeffBeltran/faker.js-docs
PR's and Fixes are welcome 馃槂
JeffBeltran
All 5 comments
@JeffBeltran I was looking for docs with more info (specifically on params each method can accept), what you have so far is what I was looking for.
Nick-Ewer
on 8 May 2019
@JeffBeltran Its so nice to see a documentation for this. This should be added in the readme as well. Thanks a lot
agarwalkartik
on 25 Jul 2019
Thanks @agarwalkartik yeah there are a few more changes i need to make but then i'll open a PR see if we can get it merged
JeffBeltran
on 26 Jul 2019
I love this library but feel like the documentation is lacking. This documentation is a real game changer. Amazing work @JeffBeltran
elebumm
on 5 Oct 2020
Nice work. Has it any additional content to the existing jsdoc comments? Not saying there is much but eventually we need to decide which way we are going in case there is differences in the *Doc comment syntax.
We also have a hosted documentation (mentioned)[http://marak.github.io/faker.js/] in the readme, but it might be outdated. Looking forward in seeing the PR @JeffBeltran
ohcibi
on 19 Oct 2020
Related issues
adoyle-h
路
3Comments
clarmso
路
3Comments
minhchu
路
3Comments
pvpshoot
路
4Comments
developdeez
路
5Comments
Most helpful comment
@JeffBeltran I was looking for docs with more info (specifically on params each method can accept), what you have so far is what I was looking for.