workshopper / learnyounode

Learn You The Node.js For Much Win! An intro to Node.js via a set of self-guided workshops.
Other
7.24k stars 1.84k forks source link

chore: automate download node docs #696

Open ccarruitero opened 4 years ago

ccarruitero commented 4 years ago

I'm adding a script for download node api docs. The files seems slightly different from current files, because font is missing; but I think we don't have to worry about docs anymore with this.

current: current proposed: proposed

martinheidegger commented 4 years ago

This is a nice pull request and definitely something worth looking at. But honestly: I would rather have a "npm install node-docs@version" dependency that has the docs in the npm module with a path.

ccarruitero commented 4 years ago

@martinheidegger I found that in the npm's information for that package (node-docs) is missing the repository also haven't any release.

My concern about use a dependency for docs is that the dependency could become unmaintained.

I think the script proposed isn't too big; and just scrape api docs from nodejs.org, rename result folder and cleanup other files.

martinheidegger commented 4 years ago

I missed to reply here: The reason i bring it up is that this documentation may be used by other workshoppers (i.e. going-native). We could just create a @workshopper/node-docs package.

What do you think?

ccarruitero commented 4 years ago

That's sounds good.

But I prefer that the docs package just scrape node docs. That way is more easy to maintain the package.

We could scrape latest version by default and use an env variable for a specific node version.