the-phpjs-local-docs-collection icon indicating copy to clipboard operation
the-phpjs-local-docs-collection copied to clipboard

Published 20 hours ago • verified publisher icon rafaelgou
→

Metadata

The PHP/JS Local Docs Collection - A HUGE Collection of PHP and Javascript related documentation

#The PHP/Javascript Local Docs Collection

DEPRECATED: Since this project had borned, some cool (and better) options appeared. I do recomend DevDocs;

A HUGE doc collection for PHP and Javascript web developers.

Compiled by Rafael Goulart.

Install

Be sure to have PHP-CLI installed.

Use a local Apache install directory for cloning.

Considering a default Apache installation:

cd /var/www
git clone https://github.com/rafaelgou/the-phpjs-local-docs-collection.git

And have a coffee (it's about 650Mb to download from GitHub).

Now you need Composer.

Start by downloading Composer onto your computer. If you have curl installed, it’s as easy as:

cd the-phpjs-local-docs-collection
curl -s https://getcomposer.org/installer | php

With composer installed, then you get the dependencies:

./composer.phar install

Copy autorender.yml.dist to autorender.yml:

cp autorender.yml.dist autorender.yml

Be sure to open this file and check the default paths. If you've followed the instructions above, you've used /var/www as parent and clone without changing the target directory, then the default values are enough.

If your local web server runs at http://localhost, then you are able now to navigate at http://localhost/the-phpjs-local-docs-collection .

That's all!

What is for?

I'm a kind of paranoic about being offline without any references.

So I did this research and put almost everything I need offline.

All Local?

Yes, but eventually some docs still gets some assets remotely. As soon as I discover, I will clean up.

Where are the docs sources?

  • If it's possible, direct download in HTML from the original website;
  • Then I make a search on http://readthedocs.org - and downloaded from there;
  • If it's available , I compile from the sources;
  • If the docs are on Markdown so I use Doc Renderer to render on-the-fly from sources;
  • Some docs I get from apt-get install bla-docs;
  • If it's still not avaliable, brute-force wget and manual cleaning is the last try.

What is still missing?

A REALLY good HTML, Javascript, DOM and CSS references are not available for download (if you find anywhere, tell me!). There's nothing like https://developer.mozilla.org/ in my opinion, but it's hard to compile it.

But you can run a local instace of DocHub NodeJS project, it's pretty awesome! Don't waste your time, get this stuff! (but DON'T try to update it's resources, it's broken, at least for me).

What is on the list?

Here we go:

What languages are available?

Almost all docs in English, some in English and Portuguese, and just two great references only in Portuguese (I use them, sorry, it must fit my needs firstly).

Licences

All docs are licensed to permit redistribuition. If for some reason I'd made a mistake, please let me know to exclude the doc. It's important to respect the authors.

This project is licensed under GPL3

← Metadata

19
Stars
6
Forks
Watchers

Owner

verified publisher icon rafaelgou

Metadata

The PHP/JS Local Docs Collection - A HUGE Collection of PHP and Javascript related documentation

Back