diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..03c17bf8
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md
similarity index 69%
rename from CONTRIBUTING.md
rename to .github/CONTRIBUTING.md
index bdb36d55..0c53b8e9 100644
--- a/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -24,20 +24,18 @@ Want to contribute? Great. Please review the following guidelines carefully and
## Requesting new features
1. Search for similar feature requests; someone may have already requested it.
-2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
+2. Make sure your feature fits DevDocs's [vision](../README.md#vision).
3. Provide a clear and detailed explanation of the feature and why it's important to add it.
-For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
-
## Requesting new documentations
-Please don't open issues to request new documentations.
+Please don't open issues to request new documentations.
Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote.
## Contributing code and features
1. Search for existing issues; someone may already be working on a similar feature.
-2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature.
+2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature.
3. Follow the [coding conventions](#coding-conventions).
4. If you're modifying the Ruby code, include tests and ensure they pass.
5. Try to keep your pull request small and simple.
@@ -46,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
## Contributing new documentations
-See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations.
+See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/master/docs) to learn how to add new documentations.
**Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
@@ -57,20 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea
* Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.).
* Names must be as short as possible and unique across the documentation.
* The number of types (categories) should ideally be less than 100.
-* Don't modify the icon sprite. I'll do it after your pull request is merged.
## Updating existing documentations
-Please don't submit a pull request updating the version number of a documentation, unless a change is required in the scraper and you've verified that it works.
-
-To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
-
-## Other contributions
-
-Besides new docs and features, here are other ways you can contribute:
+Please don't submit a pull request updating only the version number and/or the attribution of a documentation. Do submit a pull request if a bigger change is required in the scraper and you've verified that it works.
-* **Improve our copy.** English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.
-* **Participate in the issue tracker.** Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).
+To ask that an existing documentation be updated, first check the latest [documentation versions report](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc). Only create an issue if the documentation has been wrongly marked as up-to-date.
## Coding conventions
@@ -80,4 +70,4 @@ Besides new docs and features, here are other ways you can contribute:
## Questions?
-If you have any questions, please feel free to ask on the [mailing list](https://groups.google.com/d/forum/devdocs).
+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..0fb624d4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,7 @@
+
diff --git a/.github/no-response.yml b/.github/no-response.yml
new file mode 100644
index 00000000..ab687134
--- /dev/null
+++ b/.github/no-response.yml
@@ -0,0 +1,8 @@
+daysUntilClose: 30
+responseRequiredLabel: needs-info
+closeComment: >
+ This issue has been automatically closed because there has been no response
+ to our request for more information from the original author. With only the
+ information that’s currently in the issue, we don’t have enough information
+ to take action. Please comment if you have or find the answer we need so we
+ can investigate further.
diff --git a/.gitignore b/.gitignore
index 8b222826..f89ecb61 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,10 +1,9 @@
.DS_Store
.bundle
-*.pxm
-*.sketch
+log
tmp
public/assets
public/fonts
public/docs/**/*
-!public/docs/docs.json
-!public/docs/**/index.json
+docs/**/*
+!docs/*.md
diff --git a/.ruby-version b/.ruby-version
index 4fd0fe3c..ec1cf33c 100644
--- a/.ruby-version
+++ b/.ruby-version
@@ -1 +1 @@
-2.5.1
\ No newline at end of file
+2.6.3
diff --git a/.slugignore b/.slugignore
index 6a7070f5..9daeafb9 100644
--- a/.slugignore
+++ b/.slugignore
@@ -1,2 +1 @@
-public/icons
-test
\ No newline at end of file
+test
diff --git a/.travis.yml b/.travis.yml
index e3fceec9..6c59f0be 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,4 +1,26 @@
language: ruby
-before_script:
+
+addons:
+ apt:
+ packages:
+ - libcurl4-openssl-dev
+
+cache: bundler
+
+before_install:
+ - "echo 'gem: --no-document' > ~/.gemrc"
- gem update --system
- gem install bundler
+
+script:
+ - if [ "$TRAVIS_EVENT_TYPE" != "cron" ]; then bundle exec rake; fi
+ - if [ "$TRAVIS_EVENT_TYPE" = "cron" ]; then bundle exec thor updates:check --github-token $GH_TOKEN --upload; fi
+
+deploy:
+ provider: heroku
+ app: devdocs
+ on:
+ branch: master
+ condition: $TRAVIS_EVENT_TYPE != cron
+ api_key:
+ secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI="
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..26f8ab09
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+
+> Our Code of Conduct is available here:
diff --git a/COPYRIGHT b/COPYRIGHT
index 719895e9..c71d2d7a 100644
--- a/COPYRIGHT
+++ b/COPYRIGHT
@@ -1,13 +1,13 @@
-Copyright 2013-2018 Thibaut Courouble and other contributors
+Copyright 2013-2019 Thibaut Courouble and other contributors
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
Please do not use the name DevDocs to endorse or promote products
-derived from this software without my permission, except as may be
-necessary to comply with the notice/attribution requirements.
+derived from this software without the maintainers' permission, except
+as may be necessary to comply with the notice/attribution requirements.
-I also wish that any documentation file generated using this software
+We also wish that any documentation file generated using this software
be attributed to DevDocs. Let's be fair to all contributors by giving
credit where credit's due. Thanks.
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index 7a2efbbc..b033427a 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,9 +1,12 @@
-FROM ruby:2.5.1
+FROM ruby:2.6.3
+
+ENV LANG=C.UTF-8
+ENV ENABLE_SERVICE_WORKER=true
WORKDIR /devdocs
RUN apt-get update && \
- apt-get -y install git nodejs && \
+ apt-get -y install git nodejs libcurl4 && \
gem install bundler && \
rm -rf /var/lib/apt/lists/*
diff --git a/Dockerfile-alpine b/Dockerfile-alpine
index 73c45225..33a06b0e 100644
--- a/Dockerfile-alpine
+++ b/Dockerfile-alpine
@@ -1,10 +1,13 @@
-FROM ruby:2.5.1-alpine
+FROM ruby:2.6.3-alpine
+
+ENV LANG=C.UTF-8
+ENV ENABLE_SERVICE_WORKER=true
WORKDIR /devdocs
COPY . /devdocs
-RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev && \
+RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev libcurl && \
gem install bundler && \
bundle install --system --without test && \
thor docs:download --all && \
diff --git a/Gemfile b/Gemfile
index 567d4c09..3c9ce68b 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,16 +1,20 @@
source 'https://rubygems.org'
-ruby '2.5.1'
+ruby '2.6.3'
gem 'rake'
gem 'thor'
-gem 'pry', '~> 0.11.0'
+gem 'pry', '~> 0.12.0'
gem 'activesupport', '~> 5.2', require: false
gem 'yajl-ruby', require: false
+gem 'html-pipeline'
+gem 'typhoeus'
+gem 'nokogiri'
group :app do
gem 'rack'
gem 'sinatra'
gem 'sinatra-contrib'
+ gem 'rack-ssl-enforcer'
gem 'thin'
gem 'sprockets'
gem 'sprockets-helpers'
@@ -18,6 +22,8 @@ group :app do
gem 'browser'
gem 'sass'
gem 'coffee-script'
+ gem 'chunky_png'
+ gem 'sprockets-sass'
end
group :production do
@@ -30,14 +36,13 @@ group :development do
end
group :docs do
- gem 'typhoeus'
- gem 'nokogiri'
- gem 'html-pipeline'
gem 'image_optim'
gem 'image_optim_pack', platforms: :ruby
gem 'progress_bar', require: false
gem 'unix_utils', require: false
gem 'tty-pager', require: false
+ gem 'net-sftp', '>= 2.1.3.rc2', require: false
+ gem 'terminal-table', require: false
end
group :test do
diff --git a/Gemfile.lock b/Gemfile.lock
index 0f2d1325..d1abb66b 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -1,124 +1,134 @@
GEM
remote: https://rubygems.org/
specs:
- activesupport (5.2.0)
+ activesupport (5.2.3)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
- backports (3.11.3)
- better_errors (2.4.0)
+ backports (3.15.0)
+ better_errors (2.5.1)
coderay (>= 1.0.0)
erubi (>= 1.0.0)
rack (>= 0.9.0)
- browser (2.5.3)
+ browser (2.6.1)
+ chunky_png (1.3.11)
coderay (1.1.2)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
- concurrent-ruby (1.0.5)
- daemons (1.2.6)
- erubi (1.7.1)
- ethon (0.11.0)
+ concurrent-ruby (1.1.5)
+ daemons (1.3.1)
+ erubi (1.8.0)
+ ethon (0.12.0)
ffi (>= 1.3.0)
eventmachine (1.2.7)
execjs (2.7.0)
- exifr (1.3.4)
- ffi (1.9.25)
- fspath (3.1.0)
- highline (1.7.10)
- html-pipeline (2.8.3)
+ exifr (1.3.6)
+ ffi (1.11.1)
+ fspath (3.1.2)
+ highline (2.0.2)
+ html-pipeline (2.11.1)
activesupport (>= 2)
nokogiri (>= 1.4)
- i18n (1.0.1)
+ i18n (1.6.0)
concurrent-ruby (~> 1.0)
- image_optim (0.26.1)
+ image_optim (0.26.5)
exifr (~> 1.2, >= 1.2.2)
fspath (~> 3.0)
- image_size (~> 1.5)
+ image_size (>= 1.5, < 3)
in_threads (~> 1.3)
progress (~> 3.0, >= 3.0.1)
- image_optim_pack (0.5.1)
+ image_optim_pack (0.5.6)
fspath (>= 2.1, < 4)
image_optim (~> 0.19)
- image_size (1.5.0)
- in_threads (1.5.0)
- method_source (0.9.0)
- mini_portile2 (2.3.0)
+ image_size (2.0.2)
+ in_threads (1.5.3)
+ method_source (0.9.2)
+ mini_portile2 (2.4.0)
minitest (5.11.3)
multi_json (1.13.1)
- mustermann (1.0.2)
- newrelic_rpm (5.2.0.345)
- nokogiri (1.8.4)
- mini_portile2 (~> 2.3.0)
+ mustermann (1.0.3)
+ net-sftp (3.0.0.beta1)
+ net-ssh (>= 5.0.0, < 6.0.0)
+ net-ssh (5.2.0)
+ newrelic_rpm (6.5.0.357)
+ nokogiri (1.10.3)
+ mini_portile2 (~> 2.4.0)
options (2.3.2)
- progress (3.4.0)
- progress_bar (1.2.0)
- highline (~> 1.6)
+ progress (3.5.2)
+ progress_bar (1.3.0)
+ highline (>= 1.6, < 3)
options (~> 2.3.0)
- pry (0.11.3)
+ pry (0.12.2)
coderay (~> 1.1.0)
method_source (~> 0.9.0)
- rack (2.0.5)
- rack-protection (2.0.3)
+ rack (2.0.7)
+ rack-protection (2.0.5)
rack
- rack-test (1.0.0)
+ rack-ssl-enforcer (0.2.9)
+ rack-test (1.1.0)
rack (>= 1.0, < 3)
- rake (12.3.1)
+ rake (12.3.2)
rb-fsevent (0.10.3)
- rb-inotify (0.9.10)
- ffi (>= 0.5.0, < 2)
+ rb-inotify (0.10.0)
+ ffi (~> 1.0)
rr (1.2.1)
- sass (3.5.6)
+ sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
- sinatra (2.0.3)
+ sinatra (2.0.5)
mustermann (~> 1.0)
rack (~> 2.0)
- rack-protection (= 2.0.3)
+ rack-protection (= 2.0.5)
tilt (~> 2.0)
- sinatra-contrib (2.0.3)
- activesupport (>= 4.0.0)
+ sinatra-contrib (2.0.5)
backports (>= 2.8.2)
multi_json
mustermann (~> 1.0)
- rack-protection (= 2.0.3)
- sinatra (= 2.0.3)
+ rack-protection (= 2.0.5)
+ sinatra (= 2.0.5)
tilt (>= 1.3, < 3)
sprockets (3.7.2)
concurrent-ruby (~> 1.0)
rack (> 1, < 3)
sprockets-helpers (1.2.1)
sprockets (>= 2.2)
- strings (0.1.1)
- unicode-display_width (~> 1.3.0)
- unicode_utils (~> 1.4.0)
+ sprockets-sass (2.0.0.beta2)
+ sprockets (>= 2.0, < 4.0)
+ strings (0.1.5)
+ strings-ansi (~> 0.1)
+ unicode-display_width (~> 1.5)
+ unicode_utils (~> 1.4)
+ strings-ansi (0.1.0)
+ terminal-table (1.8.0)
+ unicode-display_width (~> 1.1, >= 1.1.1)
thin (1.7.2)
daemons (~> 1.0, >= 1.0.9)
eventmachine (~> 1.0, >= 1.0.4)
rack (>= 1, < 3)
- thor (0.20.0)
+ thor (0.20.3)
thread_safe (0.3.6)
- tilt (2.0.8)
- tty-pager (0.11.0)
- strings (~> 0.1.0)
- tty-screen (~> 0.6.4)
- tty-which (~> 0.3.0)
- tty-screen (0.6.4)
- tty-which (0.3.0)
- typhoeus (1.3.0)
+ tilt (2.0.9)
+ tty-pager (0.12.1)
+ strings (~> 0.1.4)
+ tty-screen (~> 0.6)
+ tty-which (~> 0.4)
+ tty-screen (0.7.0)
+ tty-which (0.4.1)
+ typhoeus (1.3.1)
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
- uglifier (4.1.14)
+ uglifier (4.1.20)
execjs (>= 0.3.0, < 3)
- unicode-display_width (1.3.3)
+ unicode-display_width (1.6.0)
unicode_utils (1.4.0)
unix_utils (0.0.15)
- yajl-ruby (1.4.0)
+ yajl-ruby (1.4.1)
PLATFORMS
ruby
@@ -127,17 +137,20 @@ DEPENDENCIES
activesupport (~> 5.2)
better_errors
browser
+ chunky_png
coffee-script
erubi
html-pipeline
image_optim
image_optim_pack
minitest
+ net-sftp (>= 2.1.3.rc2)
newrelic_rpm
nokogiri
progress_bar
- pry (~> 0.11.0)
+ pry (~> 0.12.0)
rack
+ rack-ssl-enforcer
rack-test
rake
rr
@@ -146,6 +159,8 @@ DEPENDENCIES
sinatra-contrib
sprockets
sprockets-helpers
+ sprockets-sass
+ terminal-table
thin
thor
tty-pager
@@ -155,7 +170,7 @@ DEPENDENCIES
yajl-ruby
RUBY VERSION
- ruby 2.5.1p57
+ ruby 2.6.3p62
BUNDLED WITH
- 1.16.1
+ 2.0.2
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
deleted file mode 100644
index 4b173394..00000000
--- a/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..0df55970
--- /dev/null
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+If you’re adding a new scraper, please ensure that you have:
+
+- [ ] Tested the scraper on a local copy of DevDocs
+- [ ] Ensured that the docs are styled similarly to other docs on DevDocs
+
+- [ ] Added these files to the public/icons/*your_scraper_name*/ directory:
+ - [ ] `16.png`: a 16×16 pixel icon for the doc
+ - [ ] `16@2x.png`: a 32×32 pixel icon for the doc
+ - [ ] `SOURCE`: A text file containing the URL to the page the image can be found on or the URL of the original image itself
+
+
diff --git a/README.md b/README.md
index 119c6fe1..630142d4 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,24 @@
-# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
+# [DevDocs](https://devdocs.io) — API Documentation Browser [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
-DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
+DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
-* Created by [Thibaut Courouble](https://thibaut.me)
+DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org).
Keep track of development news:
* Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs)
* Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription)
* Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
-* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
-**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)
+**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [Documentation](#documentation) · [Plugins and Extensions](#plugins-and-extensions) · [License](#copyright--license) · [Questions?](#questions)
## Quick Start
-Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
+Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
-DevDocs requires Ruby 2.5.1, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
+DevDocs requires Ruby 2.6.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
```
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
@@ -60,18 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff
Many of the code's design decisions were driven by the fact that the app uses XHR to load content directly into the main frame. This includes stripping the original documents of most of their HTML markup (e.g. scripts and stylesheets) to avoid polluting the main frame, and prefixing all CSS class names with an underscore to prevent conflicts.
-Another driving factor is performance and the fact that everything happens in the browser. `applicationCache` (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
+Another driving factor is performance and the fact that everything happens in the browser. A service worker (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
DevDocs being a developer tool, the browser requirements are high:
-1. On the desktop:
- * Recent version of Chrome, Firefox, or Opera
- * Safari 8+
- * IE / Edge 10+
-2. On mobile:
- * iOS 8+
- * Android 4.1+
- * Windows Phone 8+
+* Recent versions of Firefox, Chrome, or Opera
+* Safari 11.1+
+* Edge 17+
+* iOS 11.3+
This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!
@@ -88,12 +83,13 @@ Modifications made to each document include:
* replacing all external (not scraped) URLs with their fully qualified counterpart
* replacing all internal (scraped) URLs with their unqualified and relative counterpart
* adding content, such as a title and link to the original document
+* ensuring correct syntax highlighting using [Prism](http://prismjs.com/)
These modifications are applied via a set of filters using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. Each scraper includes filters specific to itself, one of which is tasked with figuring out the pages' metadata.
The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).
-More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
+More information about [scrapers](./docs/scraper-reference.md) and [filters](./docs/filter-reference.md) is available in the `docs` folder.
## Available Commands
@@ -133,20 +129,45 @@ If multiple versions of Ruby are installed on your system, commands must be run
## Contributing
-Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md).
-
-DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
+Contributions are welcome. Please read the [contributing guidelines](./.github/CONTRIBUTING.md).
+
+## Documentation
+
+* [Adding documentations to DevDocs](./docs/adding-docs.md)
+* [Scraper Reference](./docs/scraper-reference.md)
+* [Filter Reference](./docs/filter-reference.md)
+* [Maintainers’ Guide](./docs/maintainers.md)
+
+## Plugins and Extensions
+
+* [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
+* [Ubuntu Touch app](https://uappexplorer.com/app/devdocsunofficial.berkes)
+* [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
+* [Atom plugin](https://atom.io/packages/devdocs)
+* [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
+* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
+* [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell)
+* [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
+* [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs)
+* [Vim search plugin with Devdocs in its defaults](https://github.com/waiting-for-dev/vim-www) Just set `let g:www_shortcut_engines = { 'devdocs': ['Devdocs', 'dd'] }` to have a `:Devdocs` command and a `dd` mapping.
+* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=akfish.vscode-devdocs ) (1)
+* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) (2)
+* [Desktop application](https://github.com/egoist/devdocs-desktop)
+* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets
+* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar
+* [macOS Application](https://github.com/dteoh/devdocs-macos)
+* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView
## Copyright / License
-Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
+Copyright 2013-2019 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
-This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files.
+This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](./COPYRIGHT) and [LICENSE](./LICENSE) files.
-Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements.
+Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements.
-I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
+We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
## Questions?
-If you have any questions, please feel free to ask them on the [mailing list](https://groups.google.com/d/forum/devdocs).
+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).
diff --git a/Rakefile b/Rakefile
index 3904cbd7..705c6ec1 100644
--- a/Rakefile
+++ b/Rakefile
@@ -3,6 +3,7 @@
require 'bundler/setup'
require 'thor'
+Bundler.require :default
$LOAD_PATH.unshift 'lib'
task :default do
@@ -13,6 +14,9 @@ end
namespace :assets do
desc 'Compile all assets'
task :precompile do
+ load 'tasks/docs.thor'
+ DocsCLI.new.prepare_deploy
+
load 'tasks/assets.thor'
AssetsCLI.new.compile
end
diff --git a/assets/images/.gitignore b/assets/images/.gitignore
new file mode 100644
index 00000000..4a72ec74
--- /dev/null
+++ b/assets/images/.gitignore
@@ -0,0 +1 @@
+sprites/**/*
diff --git a/assets/images/docs-1.png b/assets/images/docs-1.png
deleted file mode 100644
index c5bfb6b8..00000000
Binary files a/assets/images/docs-1.png and /dev/null differ
diff --git a/assets/images/docs-1@2x.png b/assets/images/docs-1@2x.png
deleted file mode 100644
index 1f81ecd9..00000000
Binary files a/assets/images/docs-1@2x.png and /dev/null differ
diff --git a/assets/images/docs-2.png b/assets/images/docs-2.png
deleted file mode 100644
index d096eaa2..00000000
Binary files a/assets/images/docs-2.png and /dev/null differ
diff --git a/assets/images/docs-2@2x.png b/assets/images/docs-2@2x.png
deleted file mode 100644
index 961063eb..00000000
Binary files a/assets/images/docs-2@2x.png and /dev/null differ
diff --git a/assets/javascripts/app/app.coffee b/assets/javascripts/app/app.coffee
index 979ea353..b55e552c 100644
--- a/assets/javascripts/app/app.coffee
+++ b/assets/javascripts/app/app.coffee
@@ -13,10 +13,12 @@
@el = $('._app')
@localStorage = new LocalStorageStore
- @appCache = new app.AppCache if app.AppCache.isEnabled()
+ @serviceWorker = new app.ServiceWorker if app.ServiceWorker.isEnabled()
@settings = new app.Settings
@db = new app.DB()
+ @settings.initLayout()
+
@docs = new app.collections.Docs
@disabledDocs = new app.collections.Docs
@entries = new app.collections.Entries
@@ -76,7 +78,7 @@
.install()
@previousErrorHandler = onerror
window.onerror = @onWindowError.bind(@)
- CookieStore.onBlocked = @onCookieBlocked
+ CookiesStore.onBlocked = @onCookieBlocked
return
bootOne: ->
@@ -138,7 +140,10 @@
@docs.sort()
@initDoc(doc)
@saveDocs()
- _onSuccess()
+ if app.settings.get('autoInstall')
+ doc.install(_onSuccess, onError)
+ else
+ _onSuccess()
return
doc.load onSuccess, onError, writeCache: true
@@ -147,7 +152,7 @@
saveDocs: ->
@settings.setDocs(doc.slug for doc in @docs.all())
@db.migrate()
- @appCache?.updateInBackground()
+ @serviceWorker?.updateInBackground()
welcomeBack: ->
visitCount = @settings.get('count')
@@ -157,17 +162,24 @@
new app.views.Updates()
@updateChecker = new app.UpdateChecker()
+ reboot: ->
+ if location.pathname isnt '/' and location.pathname isnt '/settings'
+ window.location = "/##{location.pathname}"
+ else
+ window.location = '/'
+ return
+
reload: ->
@docs.clearCache()
@disabledDocs.clearCache()
- if @appCache then @appCache.reload() else window.location = '/'
+ if @serviceWorker then @serviceWorker.reload() else @reboot()
return
reset: ->
@localStorage.reset()
@settings.reset()
@db?.reset()
- @appCache?.update()
+ @serviceWorker?.update()
window.location = '/'
return
@@ -186,9 +198,9 @@
return
indexHost: ->
- # Can't load the index files from the host/CDN when applicationCache is
+ # Can't load the index files from the host/CDN when service worker is
# enabled because it doesn't support caching URLs that use CORS.
- @config[if @appCache and @settings.hasDocs() then 'index_path' else 'docs_origin']
+ @config[if @serviceWorker and @settings.hasDocs() then 'index_path' else 'docs_origin']
onBootError: (args...) ->
@trigger 'bootError'
@@ -245,7 +257,7 @@
matchMedia: !!window.matchMedia
insertAdjacentHTML: !!document.body.insertAdjacentHTML
defaultPrevented: document.createEvent('CustomEvent').defaultPrevented is false
- cssGradients: supportsCssGradients()
+ cssVariables: !!CSS?.supports?('(--t: 0)')
for key, value of features when not value
Raven.captureMessage "unsupported/#{key}", level: 'info'
@@ -268,9 +280,4 @@
isInvalidLocation: ->
@config.env is 'production' and location.host.indexOf(app.config.production_host) isnt 0
-supportsCssGradients = ->
- el = document.createElement('div')
- el.style.cssText = "background-image: -webkit-linear-gradient(top, #000, #fff); background-image: linear-gradient(to top, #000, #fff);"
- el.style.backgroundImage.indexOf('gradient') >= 0
-
$.extend app, Events
diff --git a/assets/javascripts/app/appcache.coffee b/assets/javascripts/app/appcache.coffee
deleted file mode 100644
index d2606ab1..00000000
--- a/assets/javascripts/app/appcache.coffee
+++ /dev/null
@@ -1,42 +0,0 @@
-class app.AppCache
- $.extend @prototype, Events
-
- @isEnabled: ->
- try
- applicationCache and applicationCache.status isnt applicationCache.UNCACHED
- catch
-
- constructor: ->
- @cache = applicationCache
- @notifyUpdate = true
- @onUpdateReady() if @cache.status is @cache.UPDATEREADY
-
- $.on @cache, 'progress', @onProgress
- $.on @cache, 'updateready', @onUpdateReady
-
- update: ->
- @notifyUpdate = true
- @notifyProgress = true
- try @cache.update() catch
- return
-
- updateInBackground: ->
- @notifyUpdate = false
- @notifyProgress = false
- try @cache.update() catch
- return
-
- reload: ->
- $.on @cache, 'updateready noupdate error', -> window.location = '/'
- @notifyUpdate = false
- @notifyProgress = true
- try @cache.update() catch
- return
-
- onProgress: (event) =>
- @trigger 'progress', event if @notifyProgress
- return
-
- onUpdateReady: =>
- @trigger 'updateready' if @notifyUpdate
- return
diff --git a/assets/javascripts/app/config.coffee.erb b/assets/javascripts/app/config.coffee.erb
index ec26b697..a822f7e2 100644
--- a/assets/javascripts/app/config.coffee.erb
+++ b/assets/javascripts/app/config.coffee.erb
@@ -13,3 +13,6 @@ app.config =
version: <%= Time.now.to_i %>
release: <%= Time.now.utc.httpdate.to_json %>
mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'
+ favicon_spritesheet: '<%= image_path('sprites/docs.png') %>'
+ service_worker_path: '/service-worker.js'
+ service_worker_enabled: <%= App.environment == :production || ENV['ENABLE_SERVICE_WORKER'] == 'true' %>
diff --git a/assets/javascripts/app/serviceworker.coffee b/assets/javascripts/app/serviceworker.coffee
new file mode 100644
index 00000000..40235566
--- /dev/null
+++ b/assets/javascripts/app/serviceworker.coffee
@@ -0,0 +1,49 @@
+class app.ServiceWorker
+ $.extend @prototype, Events
+
+ @isEnabled: ->
+ !!navigator.serviceWorker and app.config.service_worker_enabled
+
+ constructor: ->
+ @registration = null
+ @notifyUpdate = true
+
+ navigator.serviceWorker.register(app.config.service_worker_path, {scope: '/'})
+ .then(
+ (registration) => @updateRegistration(registration),
+ (error) -> console.error('Could not register service worker:', error)
+ )
+
+ update: ->
+ return unless @registration
+ @notifyUpdate = true
+ return @registration.update().catch(->)
+
+ updateInBackground: ->
+ return unless @registration
+ @notifyUpdate = false
+ return @registration.update().catch(->)
+
+ reload: ->
+ return @updateInBackground().then(() -> app.reboot())
+
+ updateRegistration: (registration) ->
+ @registration = registration
+ $.on @registration, 'updatefound', @onUpdateFound
+ return
+
+ onUpdateFound: =>
+ $.off @installingRegistration, 'statechange', @onStateChange() if @installingRegistration
+ @installingRegistration = @registration.installing
+ $.on @installingRegistration, 'statechange', @onStateChange
+ return
+
+ onStateChange: =>
+ if @installingRegistration and @installingRegistration.state == 'installed' and navigator.serviceWorker.controller
+ @installingRegistration = null
+ @onUpdateReady()
+ return
+
+ onUpdateReady: ->
+ @trigger 'updateready' if @notifyUpdate
+ return
diff --git a/assets/javascripts/app/settings.coffee b/assets/javascripts/app/settings.coffee
index 8d309c41..350a08c0 100644
--- a/assets/javascripts/app/settings.coffee
+++ b/assets/javascripts/app/settings.coffee
@@ -5,11 +5,13 @@ class app.Settings
'manualUpdate'
'fastScroll'
'arrowScroll'
+ 'analyticsConsent'
'docs'
'dark'
'layout'
'size'
'tips'
+ 'autoInstall'
]
INTERNAL_KEYS = [
@@ -19,6 +21,8 @@ class app.Settings
'news'
]
+ LAYOUTS: ['_max-width', '_sidebar-hidden', '_native-scrollbars']
+
@defaults:
count: 0
hideDisabled: false
@@ -26,9 +30,10 @@ class app.Settings
news: 0
manualUpdate: false
schema: 1
+ analyticsConsent: false
constructor: ->
- @store = new CookieStore
+ @store = new CookiesStore
@cache = {}
get: (key) ->
@@ -38,6 +43,7 @@ class app.Settings
set: (key, value) ->
@store.set(key, value)
delete @cache[key]
+ @toggleDark(value) if key == 'dark'
return
del: (key) ->
@@ -63,6 +69,8 @@ class app.Settings
return
setLayout: (name, enable) ->
+ @toggleLayout(name, enable)
+
layout = (@store.get('layout') || '').split(' ')
$.arrayDelete(layout, '')
@@ -104,3 +112,28 @@ class app.Settings
@store.reset()
@cache = {}
return
+
+ initLayout: ->
+ @toggleDark(@get('dark') is 1)
+ @toggleLayout(layout, @hasLayout(layout)) for layout in @LAYOUTS
+ @initSidebarWidth()
+ return
+
+ toggleDark: (enable) ->
+ classList = document.documentElement.classList
+ classList.toggle('_theme-default', !enable)
+ classList.toggle('_theme-dark', enable)
+ color = getComputedStyle(document.documentElement).getPropertyValue('--headerBackground').trim()
+ $('meta[name=theme-color]').setAttribute('content', color)
+ return
+
+ toggleLayout: (layout, enable) ->
+ classList = document.body.classList
+ classList.toggle(layout, enable) unless layout is '_sidebar-hidden'
+ classList.toggle('_overlay-scrollbars', $.overlayScrollbarsEnabled())
+ return
+
+ initSidebarWidth: ->
+ size = @get('size')
+ document.documentElement.style.setProperty('--sidebarWidth', size + 'px') if size
+ return
diff --git a/assets/javascripts/app/shortcuts.coffee b/assets/javascripts/app/shortcuts.coffee
index 5bc24806..5755a71d 100644
--- a/assets/javascripts/app/shortcuts.coffee
+++ b/assets/javascripts/app/shortcuts.coffee
@@ -149,6 +149,9 @@ class app.Shortcuts
when 40
@trigger 'altDown'
false
+ when 68
+ @trigger 'altD'
+ false
when 70
@trigger 'altF', event
when 71
diff --git a/assets/javascripts/app/update_checker.coffee b/assets/javascripts/app/update_checker.coffee
index 5630b488..3558d6bc 100644
--- a/assets/javascripts/app/update_checker.coffee
+++ b/assets/javascripts/app/update_checker.coffee
@@ -3,13 +3,13 @@ class app.UpdateChecker
@lastCheck = Date.now()
$.on window, 'focus', @onFocus
- app.appCache.on 'updateready', @onUpdateReady if app.appCache
+ app.serviceWorker?.on 'updateready', @onUpdateReady
setTimeout @checkDocs, 0
check: ->
- if app.appCache
- app.appCache.update()
+ if app.serviceWorker
+ app.serviceWorker.update()
else
ajax
url: $('script[src*="application"]').getAttribute('src')
diff --git a/assets/javascripts/lib/cookie_store.coffee b/assets/javascripts/lib/cookies_store.coffee
similarity index 76%
rename from assets/javascripts/lib/cookie_store.coffee
rename to assets/javascripts/lib/cookies_store.coffee
index 3b340571..eaf1bd4f 100644
--- a/assets/javascripts/lib/cookie_store.coffee
+++ b/assets/javascripts/lib/cookies_store.coffee
@@ -1,4 +1,8 @@
-class @CookieStore
+class @CookiesStore
+ # Intentionally called CookiesStore instead of CookieStore
+ # Calling it CookieStore causes issues when the Experimental Web Platform features flag is enabled in Chrome
+ # Related issue: https://github.com/freeCodeCamp/devdocs/issues/932
+
INT = /^\d+$/
@onBlocked: ->
diff --git a/assets/javascripts/lib/favicon.coffee b/assets/javascripts/lib/favicon.coffee
new file mode 100644
index 00000000..2f2d9f93
--- /dev/null
+++ b/assets/javascripts/lib/favicon.coffee
@@ -0,0 +1,64 @@
+defaultUrl = null
+currentSlug = null
+
+imageCache = {}
+urlCache = {}
+
+withImage = (url, action) ->
+ if imageCache[url]
+ action(imageCache[url])
+ else
+ img = new Image()
+ img.crossOrigin = 'anonymous'
+ img.src = url
+ img.onload = () =>
+ imageCache[url] = img
+ action(img)
+
+@setFaviconForDoc = (doc) ->
+ return if currentSlug == doc.slug
+
+ favicon = $('link[rel="icon"]')
+
+ if defaultUrl == null
+ defaultUrl = favicon.href
+
+ if urlCache[doc.slug]
+ favicon.href = urlCache[doc.slug]
+ currentSlug = doc.slug
+ return
+
+ styles = window.getComputedStyle($("._icon-#{doc.slug.split('~')[0]}"), ':before')
+
+ bgUrl = app.config.favicon_spritesheet
+ sourceSize = 16
+ sourceX = Math.abs(parseInt(styles['background-position-x'].slice(0, -2)))
+ sourceY = Math.abs(parseInt(styles['background-position-y'].slice(0, -2)))
+
+ withImage(bgUrl, (docImg) ->
+ withImage(defaultUrl, (defaultImg) ->
+ size = defaultImg.width
+
+ canvas = document.createElement('canvas')
+ ctx = canvas.getContext('2d')
+
+ canvas.width = size
+ canvas.height = size
+ ctx.drawImage(defaultImg, 0, 0)
+
+ docIconPercentage = 65
+ destinationCoords = size / 100 * (100 - docIconPercentage)
+ destinationSize = size / 100 * docIconPercentage
+ ctx.drawImage(docImg, sourceX, sourceY, sourceSize, sourceSize, destinationCoords, destinationCoords, destinationSize, destinationSize)
+
+ urlCache[doc.slug] = canvas.toDataURL()
+ favicon.href = urlCache[doc.slug]
+
+ currentSlug = doc.slug
+ )
+ )
+
+@resetFavicon = () ->
+ if defaultUrl != null and currentSlug != null
+ $('link[rel="icon"]').href = defaultUrl
+ currentSlug = null
diff --git a/assets/javascripts/lib/license.coffee b/assets/javascripts/lib/license.coffee
index 8ff7c6e2..7f7ca938 100644
--- a/assets/javascripts/lib/license.coffee
+++ b/assets/javascripts/lib/license.coffee
@@ -1,5 +1,5 @@
###
- * Copyright 2013-2018 Thibaut Courouble and other contributors
+ * Copyright 2013-2019 Thibaut Courouble and other contributors
*
* This source code is licensed under the terms of the Mozilla
* Public License, v. 2.0, a copy of which may be obtained at:
diff --git a/assets/javascripts/lib/page.coffee b/assets/javascripts/lib/page.coffee
index 8df7422e..91d73432 100644
--- a/assets/javascripts/lib/page.coffee
+++ b/assets/javascripts/lib/page.coffee
@@ -190,7 +190,7 @@ isSameOrigin = (url) ->
updateCanonicalLink = ->
@canonicalLink ||= document.head.querySelector('link[rel="canonical"]')
- @canonicalLink.setAttribute('href', "http://#{location.host}#{location.pathname}")
+ @canonicalLink.setAttribute('href', "https://#{location.host}#{location.pathname}")
trackers = []
@@ -199,5 +199,21 @@ page.track = (fn) ->
return
track = ->
- tracker.call() for tracker in trackers
+ consentGiven = Cookies.get('analyticsConsent')
+ consentAsked = Cookies.get('analyticsConsentAsked')
+
+ if consentGiven == '1'
+ tracker.call() for tracker in trackers
+ else if consentGiven == undefined and consentAsked == undefined
+ # Only ask for consent once per browser session
+ Cookies.set('analyticsConsentAsked', '1')
+
+ new app.views.Notif 'AnalyticsConsent', autoHide: null
+ return
+
+@resetAnalytics = ->
+ for cookie in document.cookie.split(/;\s?/)
+ name = cookie.split('=')[0]
+ if name[0] == '_' && name[1] != '_'
+ Cookies.expire(name)
return
diff --git a/assets/javascripts/lib/util.coffee b/assets/javascripts/lib/util.coffee
index 058106fd..001b13de 100644
--- a/assets/javascripts/lib/util.coffee
+++ b/assets/javascripts/lib/util.coffee
@@ -352,6 +352,10 @@ isIE = null
$.isIE = ->
isIE ?= navigator.userAgent?.indexOf('MSIE') >= 0 || navigator.userAgent?.indexOf('rv:11.0') >= 0
+isChromeForAndroid = null
+$.isChromeForAndroid = ->
+ isChromeForAndroid ?= navigator.userAgent?.indexOf('Android') >= 0 && /Chrome\/([.0-9])+ Mobile/.test(navigator.userAgent)
+
isAndroid = null
$.isAndroid = ->
isAndroid ?= navigator.userAgent?.indexOf('Android') >= 0
diff --git a/assets/javascripts/models/doc.coffee b/assets/javascripts/models/doc.coffee
index 2d5f7e4a..c51e13fa 100644
--- a/assets/javascripts/models/doc.coffee
+++ b/assets/javascripts/models/doc.coffee
@@ -142,4 +142,6 @@ class app.models.Doc extends app.Model
return
isOutdated: (status) ->
- status and status.installed and @mtime isnt status.mtime
+ return false if not status
+ isInstalled = status.installed or app.settings.get('autoInstall')
+ isInstalled and @mtime isnt status.mtime
diff --git a/assets/javascripts/news.json b/assets/javascripts/news.json
index 37bba8ec..0266dea3 100644
--- a/assets/javascripts/news.json
+++ b/assets/javascripts/news.json
@@ -1,5 +1,22 @@
[
[
+ "2019-07-21",
+ "Fixed several bugs, added an option to automatically download documentation and more."
+ ],
+ [
+ "2019-07-19",
+ "Replaced the AppCache with a Service Worker (which makes DevDocs an installable PWA) and fixed layout preferences on Firefox."
+ ],
+ [
+ "2018-09-23",
+ "New documentations: Puppeteer and Handlebars.js"
+ ], [
+ "2018-08-12",
+ "New documentations: Dart and Qt"
+ ], [
+ "2018-07-29",
+ "New documentations: Bash, Graphite and Pygame"
+ ], [
"2018-07-08",
"New documentations: Leaflet, Terraform and Koa"
], [
diff --git a/assets/javascripts/templates/error_tmpl.coffee b/assets/javascripts/templates/error_tmpl.coffee
index 9c19c0a6..9cca1f9d 100644
--- a/assets/javascripts/templates/error_tmpl.coffee
+++ b/assets/javascripts/templates/error_tmpl.coffee
@@ -12,8 +12,8 @@ app.templates.notFoundPage = ->
app.templates.pageLoadError = ->
error """ The page failed to load. """,
- """ It may be missing from the server (try reloading the app) or you could be offline.
- If you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,
+ """ It may be missing from the server (try reloading the app) or you could be offline (try installing the documentation for offline usage when online again).
+ If you're online and you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,
""" #{back} · Reload
· Retry """
@@ -56,21 +56,18 @@ app.templates.unsupportedBrowser = """
Your browser is unsupported, sorry.
DevDocs is an API documentation browser which supports the following browsers:
-
Recent versions of Chrome and Firefox
-
Safari 5.1+
-
Opera 12.1+
-
Internet Explorer 10+
-
iOS 6+
-
Android 4.1+
-
Windows Phone 8+
+
Recent versions of Firefox, Chrome, or Opera
+
Safari 11.1+
+
Edge 17+
+
iOS 11.3+
- If you're unable to upgrade, I apologize.
- I decided to prioritize speed and new features over support for older browsers.
+ If you're unable to upgrade, we apologize.
+ We decided to prioritize speed and new features over support for older browsers.
Note: if you're already using one of the browsers above, check your settings and add-ons.
The app uses feature detection, not user agent sniffing.
- — Thibaut @DevDocs
+ — @DevDocs
"""
diff --git a/assets/javascripts/templates/notif_tmpl.coffee b/assets/javascripts/templates/notif_tmpl.coffee
index 93611a5c..0821036e 100644
--- a/assets/javascripts/templates/notif_tmpl.coffee
+++ b/assets/javascripts/templates/notif_tmpl.coffee
@@ -68,3 +68,9 @@ app.templates.notifShare = ->
app.templates.notifUpdateDocs = ->
textNotif """ Documentation updates available. """,
""" Install them as soon as possible to avoid broken pages. """
+
+app.templates.notifAnalyticsConsent = ->
+ textNotif """ Tracking cookies """,
+ """ We would like to gather usage data about how DevDocs is used through Google Analytics and Gauges. We only collect anonymous traffic information.
+ Please confirm if you accept our tracking cookies. You can always change your decision in the settings.
+ Accept or Decline """
diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee
index 72fb74cd..51d76c61 100644
--- a/assets/javascripts/templates/pages/about_tmpl.coffee
+++ b/assets/javascripts/templates/pages/about_tmpl.coffee
@@ -11,22 +11,18 @@ app.templates.aboutPage = -> """
DevDocs: API Documentation Browser
-
DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
-
DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
+
- Copyright 2013–2018 Thibaut Courouble and other contributors
+ Copyright 2013–2019 Thibaut Courouble and other contributors
This software is licensed under the terms of the Mozilla Public License v2.0.
You may obtain a copy of the source code at github.com/freeCodeCamp/devdocs.
For more information, see the COPYRIGHT
@@ -48,11 +44,10 @@ app.templates.aboutPage = -> """
Where can I suggest new docs and features?
You can suggest and vote for new docs on the Trello board.
If you have a specific feature request, add it to the issue tracker.
- Otherwise use the mailing list.
+ Otherwise, come talk to us in the Gitter chat room.
We do not collect personal information through the app.
+
We use Google Analytics and Gauges to collect anonymous traffic information if you have given consent to this. You can change your decision in the settings.
+
We use Sentry to collect crash data and improve the app.
The app uses cookies to store user preferences.
By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app.
-
If you have any questions regarding privacy, please email thibaut@devdocs.io.
+
Tip: If the cursor is no longer in the search field, press / or
diff --git a/assets/javascripts/templates/pages/offline_tmpl.coffee b/assets/javascripts/templates/pages/offline_tmpl.coffee
index a9a3c21c..bb9e06e8 100644
--- a/assets/javascripts/templates/pages/offline_tmpl.coffee
+++ b/assets/javascripts/templates/pages/offline_tmpl.coffee
@@ -25,8 +25,8 @@ app.templates.offlinePage = (docs) -> """
Questions & Answers
How does this work?
-
Each page is cached as a key-value pair in IndexedDB (downloaded from a single file).
- The app also uses AppCache and localStorage to cache the assets and index files.
+
Each page is cached as a key-value pair in IndexedDB (downloaded from a single file).
+ The app also uses Service Workers and localStorage to cache the assets and index files.
Can I close the tab/browser?
#{canICloseTheTab()}
What if I don't update a documentation?
@@ -41,10 +41,15 @@ app.templates.offlinePage = (docs) -> """
"""
canICloseTheTab = ->
- if app.AppCache.isEnabled()
+ if app.ServiceWorker.isEnabled()
""" Yes! Even offline, you can open a new tab, go to devdocs.io, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """
else
- """ No. AppCache isn't available in your browser (or is disabled), so loading devdocs.io offline won't work.
+ reason = "aren't available in your browser (or are disabled)"
+
+ if app.config.env != 'production'
+ reason = "are disabled in your development instance of DevDocs (enable them by setting the ENABLE_SERVICE_WORKER environment variable to true)"
+
+ """ No. Service Workers #{reason}, so loading devdocs.io offline won't work.
The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """
app.templates.offlineDoc = (doc, status) ->
diff --git a/assets/javascripts/templates/pages/root_tmpl.coffee.erb b/assets/javascripts/templates/pages/root_tmpl.coffee.erb
index ef5ee8e6..714e0e20 100644
--- a/assets/javascripts/templates/pages/root_tmpl.coffee.erb
+++ b/assets/javascripts/templates/pages/root_tmpl.coffee.erb
@@ -8,13 +8,13 @@ app.templates.intro = """
Thanks for downloading DevDocs. Here are a few things you should know:
Your local version of DevDocs won't self-update. Unless you're modifying the code,
- I recommend using the hosted version at devdocs.io.
+ we recommend using the hosted version at devdocs.io.
Run thor docs:list to see all available documentations.
Run thor docs:download <name> to download documentations.
Run thor docs:download --installed to update all downloaded documentations.
To be notified about new versions, don't forget to watch the repository on GitHub.
The issue tracker is the preferred channel for bug reports and
- feature requests. For everything else, use the mailing list.
+ feature requests. For everything else, use Gitter.
DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
see the COPYRIGHT and
@@ -39,7 +39,7 @@ app.templates.intro = """
DevDocs works offline, on mobile, and can be installed on Chrome.
When using the HTTPS version, your preferences will carry over automatically, but your offline data will be reset. Simply re-download documentation in the Offline area, and you'll be all set to use DevDocs securely offline.
-
Sorry for the inconvenience. This migration is needed because browsers are removing support for certain DOM APIs that power DevDocs's offline mode over non-secure origins.
-
Thanks for using DevDocs, and happy coding!
-
-"""
diff --git a/assets/javascripts/templates/pages/settings_tmpl.coffee b/assets/javascripts/templates/pages/settings_tmpl.coffee
index 1d439edb..94afe3df 100644
--- a/assets/javascripts/templates/pages/settings_tmpl.coffee
+++ b/assets/javascripts/templates/pages/settings_tmpl.coffee
@@ -15,6 +15,14 @@ app.templates.settingsPage = (settings) -> """
Automatically hide and show the sidebar
Tip: drag the edge of the sidebar to resize it.
+
+
diff --git a/assets/javascripts/tracking.js b/assets/javascripts/tracking.js
index ca05b218..a68ca493 100644
--- a/assets/javascripts/tracking.js
+++ b/assets/javascripts/tracking.js
@@ -1,28 +1,32 @@
try {
- if (app.config.env == 'production') {
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
- ga('create', 'UA-5544833-12', 'devdocs.io');
- page.track(function() {
- ga('send', 'pageview', {
- page: location.pathname + location.search + location.hash,
- dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version
+ if (app.config.env === 'production') {
+ if (Cookies.get('analyticsConsent') === '1') {
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+ ga('create', 'UA-5544833-12', 'devdocs.io');
+ page.track(function() {
+ ga('send', 'pageview', {
+ page: location.pathname + location.search + location.hash,
+ dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version
+ });
});
- });
- page.track(function() {
- if (window._gauges)
- _gauges.push(['track']);
- else
- (function() {
- var _gauges=_gauges||[];!function(){var a=document.createElement("script");
- a.type="text/javascript",a.async=!0,a.id="gauges-tracker",
- a.setAttribute("data-site-id","51c15f82613f5d7819000067"),
- a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0];
- b.parentNode.insertBefore(a,b)}();
- })();
- });
+ page.track(function() {
+ if (window._gauges)
+ _gauges.push(['track']);
+ else
+ (function() {
+ var _gauges=_gauges||[];!function(){var a=document.createElement("script");
+ a.type="text/javascript",a.async=!0,a.id="gauges-tracker",
+ a.setAttribute("data-site-id","51c15f82613f5d7819000067"),
+ a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0];
+ b.parentNode.insertBefore(a,b)}();
+ })();
+ });
+ } else {
+ resetAnalytics();
+ }
}
} catch(e) { }
diff --git a/assets/javascripts/vendor/fastclick.js b/assets/javascripts/vendor/fastclick.js
index 3af4f9d6..b6f7b40c 100755
--- a/assets/javascripts/vendor/fastclick.js
+++ b/assets/javascripts/vendor/fastclick.js
@@ -413,7 +413,7 @@
// when the user next taps anywhere else on the page, new touchstart and touchend events are dispatched
// with the same identifier as the touch event that previously triggered the click that triggered the alert.
// Sadly, there is an issue on iOS 4 that causes some normal touch events to have the same identifier as an
- // immediately preceeding touch event (issue #52), so this fix is unavailable on that platform.
+ // immediately preceding touch event (issue #52), so this fix is unavailable on that platform.
// Issue 120: touch.identifier is 0 when Chrome dev tools 'Emulate touch events' is set with an iOS device UA string,
// which causes all touch events to be ignored. As this block only applies to iOS, and iOS identifiers are always long,
// random integers, it's safe to to continue if the identifier is 0 here.
@@ -805,7 +805,7 @@
}
}
- // IE11: prefixed -ms-touch-action is no longer supported and it's recomended to use non-prefixed version
+ // IE11: prefixed -ms-touch-action is no longer supported and it's recommended to use non-prefixed version
// http://msdn.microsoft.com/en-us/library/windows/apps/Hh767313.aspx
if (layer.style.touchAction === 'none' || layer.style.touchAction === 'manipulation') {
return true;
diff --git a/assets/javascripts/vendor/prism.js b/assets/javascripts/vendor/prism.js
index 3dc04a14..09d6df87 100644
--- a/assets/javascripts/vendor/prism.js
+++ b/assets/javascripts/vendor/prism.js
@@ -1,4 +1,5 @@
-/* http://prismjs.com/download.html?themes=prism&languages=markup+css+clike+javascript+c+bash+cpp+coffeescript+ruby+d+django+elixir+erlang+go+java+json+kotlin+lua+nginx+nim+perl+php+python+jsx+crystal+rust+scss+sql+typescript+yaml */
+/* PrismJS 1.15.0
+https://prismjs.com/download.html#themes=prism&languages=markup+css+clike+javascript+c+bash+cpp+coffeescript+ruby+d+dart+django+elixir+markup-templating+erlang+go+java+json+kotlin+lua+crystal+nginx+nim+perl+php+sql+scss+python+jsx+typescript+rust+yaml */
var _self = (typeof window !== 'undefined')
? window // if in browser
: (
@@ -16,11 +17,12 @@ var _self = (typeof window !== 'undefined')
var Prism = (function(){
// Private helper vars
-var lang = /\blang(?:uage)?-(\w+)\b/i;
+var lang = /\blang(?:uage)?-([\w-]+)\b/i;
var uniqueId = 0;
var _ = _self.Prism = {
manual: _self.Prism && _self.Prism.manual,
+ disableWorkerMessageHandler: _self.Prism && _self.Prism.disableWorkerMessageHandler,
util: {
encode: function (tokens) {
if (tokens instanceof Token) {
@@ -44,23 +46,38 @@ var _ = _self.Prism = {
},
// Deep clone a language definition (e.g. to extend it)
- clone: function (o) {
+ clone: function (o, visited) {
var type = _.util.type(o);
+ visited = visited || {};
switch (type) {
case 'Object':
+ if (visited[_.util.objId(o)]) {
+ return visited[_.util.objId(o)];
+ }
var clone = {};
+ visited[_.util.objId(o)] = clone;
for (var key in o) {
if (o.hasOwnProperty(key)) {
- clone[key] = _.util.clone(o[key]);
+ clone[key] = _.util.clone(o[key], visited);
}
}
return clone;
case 'Array':
- return o.map(function(v) { return _.util.clone(v); });
+ if (visited[_.util.objId(o)]) {
+ return visited[_.util.objId(o)];
+ }
+ var clone = [];
+ visited[_.util.objId(o)] = clone;
+
+ o.forEach(function (v, i) {
+ clone[i] = _.util.clone(v, visited);
+ });
+
+ return clone;
}
return o;
@@ -155,6 +172,10 @@ var _ = _self.Prism = {
plugins: {},
highlightAll: function(async, callback) {
+ _.highlightAllUnder(document, async, callback);
+ },
+
+ highlightAllUnder: function(container, async, callback) {
var env = {
callback: callback,
selector: 'code[class*="language-"], [class*="language-"] code, code[class*="lang-"], [class*="lang-"] code'
@@ -162,7 +183,7 @@ var _ = _self.Prism = {
_.hooks.run("before-highlightall", env);
- var elements = env.elements || document.querySelectorAll(env.selector);
+ var elements = env.elements || container.querySelectorAll(env.selector);
for (var i=0, element; element = elements[i++];) {
_.highlightElement(element, async === true, env.callback);
@@ -185,11 +206,13 @@ var _ = _self.Prism = {
// Set language on the element, if not present
element.className = element.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
- // Set language on the parent, for styling
- parent = element.parentNode;
+ if (element.parentNode) {
+ // Set language on the parent, for styling
+ parent = element.parentNode;
- if (/pre/i.test(parent.nodeName)) {
- parent.className = parent.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
+ if (/pre/i.test(parent.nodeName)) {
+ parent.className = parent.className.replace(lang, '').replace(/\s+/g, ' ') + ' language-' + language;
+ }
}
var code = element.textContent;
@@ -251,8 +274,15 @@ var _ = _self.Prism = {
},
highlight: function (text, grammar, language) {
- var tokens = _.tokenize(text, grammar);
- return Token.stringify(_.util.encode(tokens), language);
+ var env = {
+ code: text,
+ grammar: grammar,
+ language: language
+ };
+ _.hooks.run('before-tokenize', env);
+ env.tokens = _.tokenize(env.code, env.grammar);
+ _.hooks.run('after-tokenize', env);
+ return Token.stringify(_.util.encode(env.tokens), env.language);
},
matchGrammar: function (text, strarr, grammar, index, startPos, oneshot, target) {
@@ -300,15 +330,9 @@ var _ = _self.Prism = {
continue;
}
- pattern.lastIndex = 0;
-
- var match = pattern.exec(str),
- delNum = 1;
-
- // Greedy patterns can override/remove up to two previously matched tokens
- if (!match && greedy && i != strarr.length - 1) {
+ if (greedy && i != strarr.length - 1) {
pattern.lastIndex = pos;
- match = pattern.exec(text);
+ var match = pattern.exec(text);
if (!match) {
break;
}
@@ -327,11 +351,8 @@ var _ = _self.Prism = {
}
}
- /*
- * If strarr[i] is a Token, then the match starts inside another Token, which is invalid
- * If strarr[k - 1] is greedy we are in conflict with another greedy pattern
- */
- if (strarr[i] instanceof Token || strarr[k - 1].greedy) {
+ // If strarr[i] is a Token, then the match starts inside another Token, which is invalid
+ if (strarr[i] instanceof Token) {
continue;
}
@@ -339,6 +360,11 @@ var _ = _self.Prism = {
delNum = k - i;
str = text.slice(pos, p);
match.index -= pos;
+ } else {
+ pattern.lastIndex = 0;
+
+ var match = pattern.exec(str),
+ delNum = 1;
}
if (!match) {
@@ -350,7 +376,7 @@ var _ = _self.Prism = {
}
if(lookbehind) {
- lookbehindLength = match[1].length;
+ lookbehindLength = match[1] ? match[1].length : 0;
}
var from = match.index + lookbehindLength,
@@ -480,18 +506,21 @@ Token.stringify = function(o, language, parent) {
// // in Node.js
// return _self.Prism;
// }
-// // In worker
-// _self.addEventListener('message', function(evt) {
-// var message = JSON.parse(evt.data),
-// lang = message.language,
-// code = message.code,
-// immediateClose = message.immediateClose;
-
-// _self.postMessage(_.highlight(code, _.languages[lang], lang));
-// if (immediateClose) {
-// _self.close();
-// }
-// }, false);
+
+// if (!_.disableWorkerMessageHandler) {
+// // In worker
+// _self.addEventListener('message', function (evt) {
+// var message = JSON.parse(evt.data),
+// lang = message.language,
+// code = message.code,
+// immediateClose = message.immediateClose;
+
+// _self.postMessage(_.highlight(code, _.languages[lang], lang));
+// if (immediateClose) {
+// _self.close();
+// }
+// }, false);
+// }
// return _self.Prism;
// }
@@ -535,7 +564,8 @@ Prism.languages.markup = {
'doctype': //i,
'cdata': //i,
'tag': {
- pattern: /<\/?(?!\d)[^\s>\/=$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|[^\s'">=]+))?)*\s*\/?>/i,
+ pattern: /<\/?(?!\d)[^\s>\/=$<%]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|[^\s'">=]+))?)*\s*\/?>/i,
+ greedy: true,
inside: {
'tag': {
pattern: /^<\/?[^\s>\/]+/i,
@@ -600,13 +630,13 @@ Prism.languages.css = {
pattern: /("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,
greedy: true
},
- 'property': /[\w-]+(?=\s*:)/i,
+ 'property': /[-_a-z\xA0-\uFFFF][-\w\xA0-\uFFFF]*(?=\s*:)/i,
'important': /\B!important\b/i,
'function': /[-a-z0-9]+(?=\()/i,
'punctuation': /[(){};:]/
};
-Prism.languages.css['atrule'].inside.rest = Prism.util.clone(Prism.languages.css);
+Prism.languages.css['atrule'].inside.rest = Prism.languages.css;
if (Prism.languages.markup) {
Prism.languages.insertBefore('markup', 'tag', {
@@ -614,10 +644,11 @@ if (Prism.languages.markup) {
pattern: /(
diff --git a/views/index.erb b/views/index.erb
index ce743671..4fb96153 100644
--- a/views/index.erb
+++ b/views/index.erb
@@ -1,5 +1,5 @@
- prefix="og: http://ogp.me/ns#" lang="en" class="_booting">
+
@@ -14,6 +14,7 @@
+
DevDocs API Documentation
@@ -30,9 +31,9 @@
-
+ <%= stylesheet_tag 'application' %>
->
+
<%= erb :app -%>
<%= javascript_tag 'application', asset_host: false %>
diff --git a/views/manifest.erb b/views/manifest.erb
deleted file mode 100644
index 9d2df923..00000000
--- a/views/manifest.erb
+++ /dev/null
@@ -1,14 +0,0 @@
-CACHE MANIFEST
-# <%= app_theme %> <%= app_size %> <%= app_layout %>
-
-CACHE:
-/
-<%= manifest_asset_urls.join "\n" %>
-<%= doc_index_urls.join "\n" %>
-
-NETWORK:
-/s/
-*
-
-FALLBACK:
-/ /
diff --git a/views/other.erb b/views/other.erb
index f8c9eee6..45cab943 100644
--- a/views/other.erb
+++ b/views/other.erb
@@ -5,15 +5,16 @@
<% if doc_index_page? %><% else %><% end %>
+
DevDocs<%= " — #{@doc['full_name']} documentation" if doc_index_page? %>
-
+ <%= stylesheet_tag 'application' %>
- data-doc="<%= CGI::escape_html @doc.to_json %>">
+
<%= erb :app -%>
<%= javascript_tag 'application', asset_host: false %><% unless App.production? %>
diff --git a/views/service-worker.js.erb b/views/service-worker.js.erb
new file mode 100644
index 00000000..aa234c19
--- /dev/null
+++ b/views/service-worker.js.erb
@@ -0,0 +1,61 @@
+<%# The name of the cache to store responses in %>
+<%# If the cache name changes DevDocs is assumed to be updated %>
+const cacheName = '<%= service_worker_cache_name %>';
+
+<%# Url's to cache when the service worker is installed %>
+const urlsToCache = [
+ '/',
+ '/favicon.ico',
+ '/manifest.json',
+ '<%= service_worker_asset_urls.join "',\n '" %>',
+ '<%= doc_index_urls.join "',\n '" %>',
+];
+
+<%# Set-up the cache %>
+self.addEventListener('install', event => {
+ self.skipWaiting();
+
+ event.waitUntil(
+ caches.open(cacheName).then(cache => cache.addAll(urlsToCache)),
+ );
+});
+
+<%# Remove old caches %>
+self.addEventListener('activate', event => {
+ event.waitUntil((async () => {
+ const keys = await caches.keys();
+ const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve());
+ return Promise.all(jobs);
+ })());
+});
+
+<%# Handle HTTP requests %>
+self.addEventListener('fetch', event => {
+ event.respondWith((async () => {
+ const cachedResponse = await caches.match(event.request);
+ if (cachedResponse) return cachedResponse;
+
+ try {
+ const response = await fetch(event.request);
+
+ if (!response.ok) {
+ throw new Error(`The HTTP request failed with status code ${response.status}`);
+ }
+
+ return response;
+ } catch (err) {
+ const url = new URL(event.request.url);
+
+ <%# Attempt to return the index page from the cache if the user is visiting a url like devdocs.io/offline or devdocs.io/javascript/global_objects/array/find %>
+ <%# The index page will make sure the correct documentation or a proper offline page is shown %>
+ const pathname = url.pathname;
+ const filename = pathname.substr(1 + pathname.lastIndexOf('/')).split(/\#|\?/g)[0];
+ if (url.origin === location.origin && !filename.includes('.')) {
+ const cachedIndex = await caches.match('/');
+ if (cachedIndex) return cachedIndex;
+ }
+
+ throw err;
+ }
+ })());
+});
diff --git a/views/unsupported.erb b/views/unsupported.erb
index b64ffc3d..6c1ded7e 100644
--- a/views/unsupported.erb
+++ b/views/unsupported.erb
@@ -10,20 +10,17 @@
Your browser is unsupported, sorry.
DevDocs is an API documentation browser which supports the following browsers:
-
Recent versions of Chrome and Firefox
-
Safari 5.1+
-
Opera 12.1+
-
Internet Explorer 10+
-
iOS 6+
-
Android 4.1+
-
Windows Phone 8+
+
Recent versions of Firefox, Chrome, or Opera
+
Safari 11.1+
+
Edge 17+
+
iOS 11.3+
- If you're unable to upgrade, I apologize.
- I decided to prioritize speed and new features over support for older browsers.
+ If you're unable to upgrade, we apologize.
+ We decided to prioritize speed and new features over support for older browsers.