Git Product home page Git Product logo

the-phpjs-local-docs-collection's Introduction

#The PHP/Javascript Local Docs Collection

A HUGE doc collection for PHP and Javascript web developers.

Compiled by Rafael Goulart.

You can see a demo in rgou.net The PHP/JSC LDC Install.

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

the-phpjs-local-docs-collection's People

Contributors

rafaelgou avatar

Watchers

whsheng avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.