krisyotam/devdocs

.gitignore+1−0

@@ -1,5 +1,6 @@
1	.DS_Store	1	.DS_Store
2	.bundle	2	.bundle
		3	log
3	tmp	4	tmp
4	public/assets	5	public/assets
5	public/fonts	6	public/fonts

.travis.yml+8−0

@@ -5,3 +5,11 @@ cache: bundler · 4 unmodified lines
5	before_script:	5	before_script:
6	- gem update --system	6	- gem update --system
7	- gem install bundler	7	- gem install bundler
		8
		9	deploy:
		10	provider: heroku
		11	app: devdocs
		12	on:
		13	branch: master
		14	api_key:
		15	secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI="

Dockerfile+1−0

@@ -1,6 +1,7 @@
1	FROM ruby:2.6.0	1	FROM ruby:2.6.0
2		2
3	ENV LANG=C.UTF-8	3	ENV LANG=C.UTF-8
		4	ENV ENABLE_SERVICE_WORKER=true
4		5
5	WORKDIR /devdocs	6	WORKDIR /devdocs
6		7

Dockerfile-alpine+1−0

@@ -1,6 +1,7 @@
1	FROM ruby:2.6.0-alpine	1	FROM ruby:2.6.0-alpine
2		2
3	ENV LANG=C.UTF-8	3	ENV LANG=C.UTF-8
		4	ENV ENABLE_SERVICE_WORKER=true
4		5
5	WORKDIR /devdocs	6	WORKDIR /devdocs
6		7

README.md+5−5

assets/javascripts/app/app.coffee+13−8

     @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
       @docs.sort()
       @initDoc(doc)
       @saveDocs()
-      _onSuccess()
+      if app.settings.get('autoInstall')
+        doc.install(_onSuccess, onError)
+      else
+        _onSuccess()
       return
     doc.load onSuccess, onError, writeCache: true
   saveDocs: ->
     @settings.setDocs(doc.slug for doc in @docs.all())
     @db.migrate()
-    @appCache?.updateInBackground()
+    @serviceWorker?.updateInBackground()
   welcomeBack: ->
     visitCount = @settings.get('count')
   reload: ->
     @docs.clearCache()
     @disabledDocs.clearCache()
-    if @appCache then @appCache.reload() else @reboot()
+    if @serviceWorker then @serviceWorker.reload() else @reboot()
     return
   reset: ->
     @localStorage.reset()
     @settings.reset()
     @db?.reset()
-    @appCache?.update()
+    @serviceWorker?.update()
     window.location = '/'
     return
     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'
         matchMedia:         !!window.matchMedia
         insertAdjacentHTML: !!document.body.insertAdjacentHTML
         defaultPrevented:     document.createEvent('CustomEvent').defaultPrevented is false
-        cssVariables:         CSS.supports and CSS.supports('(--t: 0)')
+        cssVariables:       !!CSS?.supports?('(--t: 0)')
       for key, value of features when not value
         Raven.captureMessage "unsupported/#{key}", level: 'info'

assets/javascripts/app/appcache.coffee+0−42

@@ -1,42 +0,0 @@
1	class app.AppCache
2	$.extend @prototype, Events
3
4	@isEnabled: ->
5	try
6	applicationCache and applicationCache.status isnt applicationCache.UNCACHED
7	catch
8
9	constructor: ->
10	@cache = applicationCache
11	@notifyUpdate = true
12	@onUpdateReady() if @cache.status is @cache.UPDATEREADY
13
14	$.on @cache, 'progress', @onProgress
15	$.on @cache, 'updateready', @onUpdateReady
16
17	update: ->
18	@notifyUpdate = true
19	@notifyProgress = true
20	try @cache.update() catch
21	return
22
23	updateInBackground: ->
24	@notifyUpdate = false
25	@notifyProgress = false
26	try @cache.update() catch
27	return
28
29	reload: ->
30	$.on @cache, 'updateready noupdate error', -> app.reboot()
31	@notifyUpdate = false
32	@notifyProgress = true
33	try @cache.update() catch
34	return
35
36	onProgress: (event) =>
37	@trigger 'progress', event if @notifyProgress
38	return
39
40	onUpdateReady: =>
41	@trigger 'updateready' if @notifyUpdate
42	return

assets/javascripts/app/config.coffee.erb+2−0

@@ -13,3 +13,5 @@ app.config = · 12 unmodified lines
13	version: <%= Time.now.to_i %>	13	version: <%= Time.now.to_i %>
14	release: <%= Time.now.utc.httpdate.to_json %>	14	release: <%= Time.now.utc.httpdate.to_json %>
15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'	15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'
		16	service_worker_path: '/service-worker.js'
		17	service_worker_enabled: <%= App.environment == :production \|\| ENV['ENABLE_SERVICE_WORKER'] == 'true' %>

assets/javascripts/app/serviceworker.coffee+49−0

@@ -0,0 +1,49 @@
	1	class app.ServiceWorker
	2	$.extend @prototype, Events
	3
	4	@isEnabled: ->
	5	!!navigator.serviceWorker and app.config.service_worker_enabled
	6
	7	constructor: ->
	8	@registration = null
	9	@notifyUpdate = true
	10
	11	navigator.serviceWorker.register(app.config.service_worker_path, {scope: '/'})
	12	.then(
	13	(registration) => @updateRegistration(registration),
	14	(error) -> console.error('Could not register service worker:', error)
	15	)
	16
	17	update: ->
	18	return unless @registration
	19	@notifyUpdate = true
	20	return @registration.update().catch(->)
	21
	22	updateInBackground: ->
	23	return unless @registration
	24	@notifyUpdate = false
	25	return @registration.update().catch(->)
	26
	27	reload: ->
	28	return @updateInBackground().then(() -> app.reboot())
	29
	30	updateRegistration: (registration) ->
	31	@registration = registration
	32	$.on @registration, 'updatefound', @onUpdateFound
	33	return
	34
	35	onUpdateFound: =>
	36	$.off @installingRegistration, 'statechange', @onStateChange() if @installingRegistration
	37	@installingRegistration = @registration.installing
	38	$.on @installingRegistration, 'statechange', @onStateChange
	39	return
	40
	41	onStateChange: =>
	42	if @installingRegistration and @installingRegistration.state == 'installed' and navigator.serviceWorker.controller
	43	@installingRegistration = null
	44	@onUpdateReady()
	45	return
	46
	47	onUpdateReady: ->
	48	@trigger 'updateready' if @notifyUpdate
	49	return

assets/javascripts/app/settings.coffee+33−0

     'manualUpdate'
     'fastScroll'
     'arrowScroll'
+    'analyticsConsent'
     'docs'
     'dark'
     'layout'
     'size'
     'tips'
+    'autoInstall'
   ]
   INTERNAL_KEYS = [
     'news'
   ]
+  LAYOUTS: ['_max-width', '_sidebar-hidden', '_native-scrollbars']
   @defaults:
     count: 0
     hideDisabled: false
     news: 0
     manualUpdate: false
     schema: 1
+    analyticsConsent: false
   constructor: ->
     @store = new CookieStore
   set: (key, value) ->
     @store.set(key, value)
     delete @cache[key]
+    @toggleDark(value) if key == 'dark'
     return
   del: (key) ->
     return
   setLayout: (name, enable) ->
+    @toggleLayout(name, enable)
     layout = (@store.get('layout') || '').split(' ')
     $.arrayDelete(layout, '')
     @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

assets/javascripts/app/update_checker.coffee+3−3

@@ -3,13 +3,13 @@ class app.UpdateChecker · 2 unmodified lines
3	@lastCheck = Date.now()	3	@lastCheck = Date.now()
4		4
5	$.on window, 'focus', @onFocus	5	$.on window, 'focus', @onFocus
6	app.appCache.on 'updateready', @onUpdateReady if app.appCache	6	app.serviceWorker?.on 'updateready', @onUpdateReady
7		7
8	setTimeout @checkDocs, 0	8	setTimeout @checkDocs, 0
9		9
10	check: ->	10	check: ->
11	if app.appCache	11	if app.serviceWorker
12	app.appCache.update()	12	app.serviceWorker.update()
13	else	13	else
14	ajax	14	ajax
15	url: $('script[src*="application"]').getAttribute('src')	15	url: $('script[src*="application"]').getAttribute('src')

assets/javascripts/lib/page.coffee+17−1

@@ -199,5 +199,21 @@ page.track = (fn) -> · 198 unmodified lines
199	return	199	return
200		200
201	track = ->	201	track = ->
202	tracker.call() for tracker in trackers	202	consentGiven = Cookies.get('analyticsConsent')
		203	consentAsked = Cookies.get('analyticsConsentAsked')
		204
		205	if consentGiven == '1'
		206	tracker.call() for tracker in trackers
		207	else if consentGiven == undefined and consentAsked == undefined
		208	# Only ask for consent once per browser session
		209	Cookies.set('analyticsConsentAsked', '1')
		210
		211	new app.views.Notif 'AnalyticsConsent', autoHide: null
		212	return
		213
		214	@resetAnalytics = ->
		215	for cookie in document.cookie.split(/;\s?/)
		216	name = cookie.split('=')[0]
		217	if name[0] == '_'
		218	Cookies.expire(name)
203	return	219	return

assets/javascripts/lib/util.coffee+4−0

 $.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

assets/javascripts/models/doc.coffee+3−1

@@ -142,4 +142,6 @@ class app.models.Doc extends app.Model · 141 unmodified lines
142	return	142	return
143		143
144	isOutdated: (status) ->	144	isOutdated: (status) ->
145	status and status.installed and @mtime isnt status.mtime	145	return false if not status
		146	isInstalled = status.installed or app.settings.get('autoInstall')
		147	isInstalled and @mtime isnt status.mtime

assets/javascripts/news.json+4−0

 [
+  [
+    "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: <a href=\"/puppeteer/\">Puppeteer</a> and <a href=\"/handlebars/\">Handlebars.js</a>"

assets/javascripts/templates/error_tmpl.coffee+5−5

@@ -12,8 +12,8 @@ app.templates.notFoundPage = -> · 11 unmodified lines
12		12
13	app.templates.pageLoadError = ->	13	app.templates.pageLoadError = ->
14	error """ The page failed to load. """,	14	error """ The page failed to load. """,
15	""" It may be missing from the server (try reloading the app) or you could be offline.<br>	15	""" It may be missing from the server (try reloading the app) or you could be offline (try <a href="/offline">installing the documentation for offline usage</a> when online again).<br>
16	If you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,	16	If you're online and you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """,
17	""" #{back} · <a href="/##{location.pathname}" target="_top" class="_error-link">Reload</a>	17	""" #{back} · <a href="/##{location.pathname}" target="_top" class="_error-link">Reload</a>
18	· <a href="#" class="_error-link" data-retry>Retry</a> """	18	· <a href="#" class="_error-link" data-retry>Retry</a> """
19		19
@@ -57,9 +57,9 @@ app.templates.unsupportedBrowser = """ · 37 unmodified lines
57	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:	57	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:
58	<ul class="_fail-list">	58	<ul class="_fail-list">
59	<li>Recent versions of Firefox, Chrome, or Opera	59	<li>Recent versions of Firefox, Chrome, or Opera
60	<li>Safari 9.1+	60	<li>Safari 11.1+
61	<li>Edge 16+	61	<li>Edge 17+
62	<li>iOS 10+	62	<li>iOS 11.3+
63	</ul>	63	</ul>
64	<p class="_fail-text">	64	<p class="_fail-text">
65	If you're unable to upgrade, we apologize.	65	If you're unable to upgrade, we apologize.

assets/javascripts/templates/notif_tmpl.coffee+6−0

@@ -68,3 +68,9 @@ app.templates.notifShare = -> · 67 unmodified lines
68	app.templates.notifUpdateDocs = ->	68	app.templates.notifUpdateDocs = ->
69	textNotif """ Documentation updates available. """,	69	textNotif """ Documentation updates available. """,
70	""" <a href="/offline">Install them</a> as soon as possible to avoid broken pages. """	70	""" <a href="/offline">Install them</a> as soon as possible to avoid broken pages. """
		71
		72	app.templates.notifAnalyticsConsent = ->
		73	textNotif """ Tracking cookies """,
		74	""" We would like to gather usage data about how DevDocs is used through Google Analytics and Gauges. We only collect anonymous traffic information.
		75	Please confirm if you accept our tracking cookies. You can always change your decision in the settings.
		76	<br><span class="_notif-right"><a href="#" data-behavior="accept-analytics">Accept</a> or <a href="#" data-behavior="decline-analytics">Decline</a></span> """

assets/javascripts/templates/pages/about_tmpl.coffee+2−1

   <ul>
     <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
     <li>We do not collect personal information through the app.
-    <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app.
+    <li>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 <a href="/settings">settings</a>.
+    <li>We use Sentry to collect crash data and improve the app.
     <li>The app uses cookies to store user preferences.
     <li>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.
     <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.

assets/javascripts/templates/pages/offline_tmpl.coffee+9−4

   <h2 class="_block-heading">Questions & Answers</h2>
   <dl>
     <dt>How does this work?
-    <dd>Each page is cached as a key-value pair in <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> (downloaded from a single file).<br>
+    <dd>Each page is cached as a key-value pair in <a href="https://devdocs.io/dom/indexeddb_api">IndexedDB</a> (downloaded from a single file).<br>
-        The app also uses <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache">AppCache</a> and <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">localStorage</a> to cache the assets and index files.
+        The app also uses <a href="https://devdocs.io/dom/service_worker_api/using_service_workers">Service Workers</a> and <a href="https://devdocs.io/dom/web_storage_api">localStorage</a> to cache the assets and index files.
     <dt>Can I close the tab/browser?
     <dd>#{canICloseTheTab()}
     <dt>What if I don't update a documentation?
 """
 canICloseTheTab = ->
-  if app.AppCache.isEnabled()
+  if app.ServiceWorker.isEnabled()
     """ Yes! Even offline, you can open a new tab, go to <a href="//devdocs.io">devdocs.io</a>, 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 <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
+    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 <code>ENABLE_SERVICE_WORKER</code> environment variable to <code>true</code>)"
+    """ No. Service Workers #{reason}, so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
         The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """
 app.templates.offlineDoc = (doc, status) ->

assets/javascripts/templates/pages/root_tmpl.coffee.erb+2−2

assets/javascripts/templates/pages/settings_tmpl.coffee+8−0

@@ -15,6 +15,14 @@ app.templates.settingsPage = (settings) -> """ · 14 unmodified lines
15	<input type="checkbox" form="settings" name="layout" value="_sidebar-hidden"#{if settings['_sidebar-hidden'] then ' checked' else ''}>Automatically hide and show the sidebar	15	<input type="checkbox" form="settings" name="layout" value="_sidebar-hidden"#{if settings['_sidebar-hidden'] then ' checked' else ''}>Automatically hide and show the sidebar
16	<small>Tip: drag the edge of the sidebar to resize it.</small>	16	<small>Tip: drag the edge of the sidebar to resize it.</small>
17	</label>	17	</label>
		18	<label class="_settings-label">
		19	<input type="checkbox" form="settings" name="autoInstall" value="_auto-install"#{if settings.autoInstall then ' checked' else ''}>Automatically download documentation for offline use
		20	<small>Only enable this when bandwidth isn't a concern to you.</small>
		21	</label>
		22	<label class="_settings-label">
		23	<input type="checkbox" form="settings" name="analyticsConsent"#{if settings.analyticsConsent then ' checked' else ''}>Enable tracking cookies
		24	<small>With this checked, we enable Google Analytics and Gauges to collect anonymous traffic information.</small>
		25	</label>
18	</div>	26	</div>
19	</div>	27	</div>
20		28

assets/javascripts/tracking.js+27−23

@@ -1,28 +1,32 @@
1	try {	1	try {
2	if (app.config.env == 'production') {	2	if (app.config.env === 'production') {
3	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){	3	if (Cookies.get('analyticsConsent') === '1') {
4	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),	4	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){
5	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)	5	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
6	})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');	6	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
7	ga('create', 'UA-5544833-12', 'devdocs.io');	7	})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
8	page.track(function() {	8	ga('create', 'UA-5544833-12', 'devdocs.io');
9	ga('send', 'pageview', {	9	page.track(function() {
10	page: location.pathname + location.search + location.hash,	10	ga('send', 'pageview', {
11	dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version	11	page: location.pathname + location.search + location.hash,
		12	dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version
		13	});
12	});	14	});
13	});
14		15
15	page.track(function() {	16	page.track(function() {
16	if (window._gauges)	17	if (window._gauges)
17	_gauges.push(['track']);	18	_gauges.push(['track']);
18	else	19	else
19	(function() {	20	(function() {
20	var _gauges=_gauges\|\|[];!function(){var a=document.createElement("script");	21	var _gauges=_gauges\|\|[];!function(){var a=document.createElement("script");
21	a.type="text/javascript",a.async=!0,a.id="gauges-tracker",	22	a.type="text/javascript",a.async=!0,a.id="gauges-tracker",
22	a.setAttribute("data-site-id","51c15f82613f5d7819000067"),	23	a.setAttribute("data-site-id","51c15f82613f5d7819000067"),
23	a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0];	24	a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0];
24	b.parentNode.insertBefore(a,b)}();	25	b.parentNode.insertBefore(a,b)}();
25	})();	26	})();
26	});	27	});
		28	} else {
		29	resetAnalytics();
		30	}
27	}	31	}
28	} catch(e) { }	32	} catch(e) { }

assets/javascripts/views/content/entry_page.coffee+1−1

@@ -123,7 +123,7 @@ class app.views.EntryPage extends app.View · 122 unmodified lines
123	@render @tmpl('pageLoadError')	123	@render @tmpl('pageLoadError')
124	@resetClass()	124	@resetClass()
125	@addClass @constructor.errorClass	125	@addClass @constructor.errorClass
126	app.appCache?.update()	126	app.serviceWorker?.update()
127	return	127	return
128		128
129	cache: ->	129	cache: ->

assets/javascripts/views/content/settings_page.coffee+10−11

 class app.views.SettingsPage extends app.View
-  LAYOUTS = ['_max-width', '_sidebar-hidden', '_native-scrollbars']
-  SIDEBAR_HIDDEN_LAYOUT = '_sidebar-hidden'
   @className: '_static'
   @events:
     settings.dark = app.settings.get('dark')
     settings.smoothScroll = !app.settings.get('fastScroll')
     settings.arrowScroll = app.settings.get('arrowScroll')
-    settings[layout] = app.settings.hasLayout(layout) for layout in LAYOUTS
+    settings.autoInstall = app.settings.get('autoInstall')
+    settings.analyticsConsent = app.settings.get('analyticsConsent')
+    settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS
     settings
   getTitle: ->
     'Preferences'
   toggleDark: (enable) ->
-    html = document.documentElement
-    html.classList.toggle('_theme-default')
-    html.classList.toggle('_theme-dark')
     app.settings.set('dark', !!enable)
-    app.appCache?.updateInBackground()
     return
   toggleLayout: (layout, enable) ->
-    document.body.classList[if enable then 'add' else 'remove'](layout) unless layout is SIDEBAR_HIDDEN_LAYOUT
-    document.body.classList[if $.overlayScrollbarsEnabled() then 'add' else 'remove']('_overlay-scrollbars')
     app.settings.setLayout(layout, enable)
-    app.appCache?.updateInBackground()
     return
   toggleSmoothScroll: (enable) ->
     app.settings.set('fastScroll', !enable)
     return
+  toggleAnalyticsConsent: (enable) ->
+    app.settings.set('analyticsConsent', if enable then '1' else '0')
+    resetAnalytics() unless enable
+    return
   toggle: (name, enable) ->
     app.settings.set(name, enable)
     return
         @toggleSmoothScroll input.checked
       when 'import'
         @import input.files[0], input
+      when 'analyticsConsent'
+        @toggleAnalyticsConsent input.checked
       else
         @toggle input.name, input.checked
     return

assets/javascripts/views/layout/document.coffee+7−5

@@ -75,9 +75,11 @@ class app.views.Document extends app.View · 74 unmodified lines
75	return unless target.hasAttribute('data-behavior')	75	return unless target.hasAttribute('data-behavior')
76	$.stopEvent(event)	76	$.stopEvent(event)
77	switch target.getAttribute('data-behavior')	77	switch target.getAttribute('data-behavior')
78	when 'back' then history.back()	78	when 'back' then history.back()
79	when 'reload' then window.location.reload()	79	when 'reload' then window.location.reload()
80	when 'reboot' then app.reboot()	80	when 'reboot' then app.reboot()
81	when 'hard-reload' then app.reload()	81	when 'hard-reload' then app.reload()
82	when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?')	82	when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?')
		83	when 'accept-analytics' then Cookies.set('analyticsConsent', '1') && app.reboot()
		84	when 'decline-analytics' then Cookies.set('analyticsConsent', '0') && app.reboot()
83	return	85	return

assets/javascripts/views/layout/resizer.coffee+2−9

   init: ->
     @el.setAttribute('draggable', 'true')
     @appendTo $('._app')
-    @style = $('style[data-resizer]')
-    @size = @style.getAttribute('data-size')
     return
   MIN = 260
     return unless value > 0
     value = Math.min(Math.max(Math.round(value), MIN), MAX)
     newSize = "#{value}px"
-    @style.innerHTML = @style.innerHTML.replace(new RegExp(@size, 'g'), newSize)
+    document.documentElement.style.setProperty('--sidebarWidth', newSize)
-    @size = newSize
+    app.settings.setSize(value) if save
-    if save
-      app.settings.setSize(value)
-      app.appCache?.updateInBackground()
     return
   onDragStart: (event) =>
-    @style.removeAttribute('disabled')
     event.dataTransfer.effectAllowed = 'link'
     event.dataTransfer.setData('Text', '')
     $.on(window, 'dragover', @onDrag)

assets/javascripts/views/layout/settings.coffee+1−9

     if super
       @render()
       document.body.classList.remove(SIDEBAR_HIDDEN_LAYOUT)
-      app.appCache?.on 'progress', @onAppCacheProgress
     return
   deactivate: ->
       @resetClass()
       @docPicker.detach()
       document.body.classList.add(SIDEBAR_HIDDEN_LAYOUT) if app.settings.hasLayout(SIDEBAR_HIDDEN_LAYOUT)
-      app.appCache?.off 'progress', @onAppCacheProgress
     return
   render: ->
         docs = @docPicker.getSelectedDocs()
         app.settings.setDocs(docs)
-      @saveBtn.textContent = if app.appCache then 'Downloading\u2026' else 'Saving\u2026'
+      @saveBtn.textContent = 'Saving\u2026'
       disabledDocs = new app.collections.Docs(doc for doc in app.docs.all() when docs.indexOf(doc.slug) is -1)
       disabledDocs.uninstall ->
         app.db.migrate()
       $.stopEvent(event)
       app.router.show '/'
     return
-  onAppCacheProgress: (event) =>
-    if event.lengthComputable
-      percentage = Math.round event.loaded * 100 / event.total
-      @saveBtn.textContent = "Downloading\u2026 (#{percentage}%)"
-    return

assets/javascripts/views/search/search.coffee+8−0

       .on 'results', @onResults
       .on 'end', @onEnd
+    @scope
+      .on 'change', @onScopeChange
     app.on 'ready', @onReady
     $.on window, 'hashchange', @searchUrl
     $.on window, 'focus', @onWindowFocus
     $.stopEvent(event)
     return
+  onScopeChange: =>
+    @value = ''
+    @onInput()
+    return
   afterRoute: (name, context) =>
     return if app.shortcuts.eventInProgress?.name is 'escape'
     @reset(true) if not context.init and app.router.isIndex()

assets/javascripts/views/search/search_scope.coffee+23−5

     tag:   '._search-tag'
   @events:
+    click: 'onClick'
     keydown: 'onKeydown'
+    textInput: 'onTextInput'
   @routes:
     after: 'afterRoute'
     @trigger 'change', null, previousDoc
     return
+  doScopeSearch: (event) =>
+    @search @input.value[0...@input.selectionStart]
+    $.stopEvent(event) if @doc
+    return
+  onClick: (event) =>
+    if event.target is @tag
+      @reset()
+      $.stopEvent(event)
+    return
   onKeydown: (event) =>
     if event.which is 8 # backspace
-      if @doc and not @input.value
+      if @doc and @input.selectionEnd is 0
-        $.stopEvent(event)
         @reset()
-    else if not @doc and @input.value
+        $.stopEvent(event)
+    else if not @doc and @input.value and not $.isChromeForAndroid()
       return if event.ctrlKey or event.metaKey or event.altKey or event.shiftKey
       if event.which is 9 or # tab
          (event.which is 32 and app.isMobile()) # space
-        @search @input.value[0...@input.selectionStart]
+        @doScopeSearch(event)
-        $.stopEvent(event) if @doc
+    return
+  onTextInput: (event) =>
+    return unless $.isChromeForAndroid()
+    if not @doc and @input.value and event.data == ' '
+      @doScopeSearch(event)
     return
   extractHashValue: ->

assets/javascripts/views/sidebar/sidebar.coffee+1−1

@@ -28,7 +28,7 @@ class app.views.Sidebar extends app.View · 27 unmodified lines
28		28
29	app.on 'ready', @onReady	29	app.on 'ready', @onReady
30		30
31	$.on document.documentElement, 'mouseleave', (event) => @display() if event.clientX < 10	31	$.on document.documentElement, 'mouseleave', (event) => @display() unless event.clientX <= 0
32	$.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false)	32	$.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false)
33	return	33	return
34		34

assets/stylesheets/components/_header.scss+1−0

@@ -215,5 +215,6 @@ · 214 unmodified lines
215	color: var(--textColorLight);	215	color: var(--textColorLight);
216	background: var(--searchTagBackground);	216	background: var(--searchTagBackground);
217	border-radius: 2px;	217	border-radius: 2px;
		218	cursor: pointer;
218	@extend %truncate-text;	219	@extend %truncate-text;
219	}	220	}

assets/stylesheets/components/_notif.scss+4−0

@@ -134,3 +134,7 @@ · 133 unmodified lines
134		134
135	._notif-info { color: var(--textColorLight); }	135	._notif-info { color: var(--textColorLight); }
136	}	136	}
		137
		138	._notif-right {
		139	float: right;
		140	}

docs/maintainers.md+4−5

 - Commit the changes (protip: use the `thor docs:commit` command documented below).
 - Optional: do more updates.
 - Run `thor docs:upload` (documented below).
-- [Deploy the app](#deploying-devdocs) and verify that everything works in production.
+- Push to GitHub to [deploy the app](#deploying-devdocs) and verify that everything works in production.
-- Push to GitHub.
 - Run `thor docs:clean` (documented below).
 Note: changes to `public/docs/docs.json` should never be committed. This file reflects which documentations have been downloaded or generated locally, which is always none on a fresh `git clone`.
 ## Deploying DevDocs
-Once docs have been uploaded via `thor docs:upload` (if applicable), deploying DevDocs is as simple as running `git push heroku master`. See [Heroku's documentation](https://devcenter.heroku.com/articles/git) for more information.
+Once docs have been uploaded via `thor docs:upload` (if applicable), you can push to the DevDocs master branch (or merge the PR containing the updates). If the Travis build succeeds, the Heroku application will be deployed automatically.
-- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done (you will need to reload [devdocs.io](https://devdocs.io/) a couple times for the application cache to update and the new version to load).
+- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done. Keep in mind that you'll need to wait a few seconds for the service worker to finish caching the new assets. You should see a "DevDocs has been updated" notification appear when the caching is done, after which you need to refresh the page to see the changes.
 - If you're deploying frontend changes, monitor [Sentry](https://sentry.io/devdocs/devdocs-js/) for new JS errors once the deploy is done.
 - If you're deploying server changes, monitor New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)) for Ruby exceptions and throughput or response time changes once the deploy is done.
-If any issue arises, run `heroku rollback` to rollback to the previous of the app (this can also be done via Heroku's UI). Note that this will not revert changes made to documentation files that were uploaded via `thor docs:upload`.  Try and fix the issue as quickly as possible, then re-deploy the app. Reach out to other maintainers if you need help.
+If any issue arises, run `heroku rollback` to rollback to the previous version of the app (this can also be done via Heroku's UI). Note that this will not revert changes made to documentation files that were uploaded via `thor docs:upload`.  Try and fix the issue as quickly as possible, then re-deploy the app. Reach out to other maintainers if you need help.
 If this is your first deploy, make sure another maintainer is around to assist.

lib/app.rb+35−20

     set :csp, false
+    require 'docs'
+    Docs.generate_manifest
     Dir[docs_path, root.join(assets_prefix, '*/')].each do |path|
       sprockets.append_path(path)
     end
       request.query_string.empty? ? nil : "?#{request.query_string}"
     end
-    def manifest_asset_urls
+    def service_worker_asset_urls
-      @@manifest_asset_urls ||= [
+      @@service_worker_asset_urls ||= [
         javascript_path('application', asset_host: false),
         stylesheet_path('application'),
         image_path('sprites/docs.png'),
         image_path('sprites/docs@2x.png'),
-        asset_path('docs.js')
+        asset_path('docs.js'),
-      ]
+        App.production? ? nil : javascript_path('debug'),
+      ].compact
     end
-    def app_size
+    # Returns a cache name for the service worker to use which changes if any of the assets changes
-      @app_size ||= memoized_cookies['size'].nil? ? '20rem' : "#{memoized_cookies['size']}px"
+    # When a manifest exist, this name is only created once based on the asset manifest because it never changes without a server restart
-    end
+    # If a manifest does not exist, it is created every time this method is called because the assets can change while the server is running
+    def service_worker_cache_name
+      if File.exist?(App.assets_manifest_path)
+        if defined?(@@service_worker_cache_name)
+          return @@service_worker_cache_name
+        end
-    def app_layout
+        digest = Sprockets::Manifest
-      memoized_cookies['layout']
+                   .new(nil, App.assets_manifest_path)
-    end
+                   .files
+                   .values
+                   .map {|file| file["digest"]}
+                   .join
-    def app_theme
+        return @@service_worker_cache_name ||= Digest::MD5.hexdigest(digest)
-      @app_theme ||= memoized_cookies['dark'].nil? ? 'default' : 'dark'
+      else
-    end
+        paths = App.sprockets
+                  .each_file
+                  .to_a
+                  .reject {|file| file.start_with?(App.docs_path)}
-    def dark_theme?
+        return App.sprockets.pack_hexdigest(App.sprockets.files_digest(paths))
-      app_theme == 'dark'
+      end
     end
-    def redirect_via_js(path) # courtesy of HTML5 App Cache
+    def redirect_via_js(path)
       response.set_cookie :initial_path, value: path, expires: Time.now + 15, path: '/'
       redirect '/', 302
     end
     end
   end
-  get '/manifest.appcache' do
+  get '/service-worker.js' do
-    content_type 'text/cache-manifest'
+    content_type 'application/javascript'
     expires 0, :'no-cache'
-    erb :manifest
+    erb :'service-worker.js'
   end
   get '/' do
     return redirect "/#q=#{params[:q]}" if params[:q]
-    return redirect '/' unless request.query_string.empty? # courtesy of HTML5 App Cache
+    return redirect '/' unless request.query_string.empty?
     response.headers['Content-Security-Policy'] = settings.csp if settings.csp
     erb :index
   end

lib/docs/core/scrapers/file_scraper.rb+2−2

@@ -29,7 +29,7 @@ module Docs · 28 unmodified lines
29		29
30	def request_one(url)	30	def request_one(url)
31	assert_source_directory_exists	31	assert_source_directory_exists
32	Response.new read_file(url_to_path(url)), URL.parse(url)	32	Response.new read_file(File.join(source_directory, url_to_path(url))), URL.parse(url)
33	end	33	end
34		34
35	def request_all(urls)	35	def request_all(urls)
@@ -50,7 +50,7 @@ module Docs · 14 unmodified lines
50	end	50	end
51		51
52	def read_file(path)	52	def read_file(path)
53	File.read(File.join(source_directory, path))	53	File.read(path)
54	rescue	54	rescue
55	instrument 'warn.doc', msg: "Failed to open file: #{path}"	55	instrument 'warn.doc', msg: "Failed to open file: #{path}"
56	nil	56	nil

public/docs/docs.json+0−1

@@ -1 +0,0 @@
1	[]

public/images/webapp-icon-192.png+0−0

Binary file not shown.

public/manifest.json+6−0

   "description": "API Documentation Browser",
   "start_url": "/",
   "display": "standalone",
+  "background_color": "#EEEEEE",
   "icons": [
     {
       "src": "/images/webapp-icon-32.png",
       "sizes": "128x128",
       "type": "image/png"
     },
+    {
+      "src": "/images/webapp-icon-192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
     {
       "src": "/images/webapp-icon-256.png",
       "sizes": "256x256",

test/app_test.rb+0−81

@@ -43,35 +43,6 @@ class AppTest < MiniTest::Spec · 42 unmodified lines
43	assert last_response.redirect?	43	assert last_response.redirect?
44	assert_equal 'https://example.org/', last_response['Location']	44	assert_equal 'https://example.org/', last_response['Location']
45	end	45	end
46
47	it "sets default size" do
48	get '/'
49	assert_includes last_response.body, 'data-size="20rem"'
50	end
51
52	it "sets size from cookie" do
53	set_cookie('size=42')
54	get '/'
55	assert_includes last_response.body, 'data-size="42px"'
56	end
57
58	it "sets layout from cookie" do
59	set_cookie('layout=foo')
60	get '/'
61	assert_includes last_response.body, '<body class="foo">'
62	end
63
64	it "sets the <html> theme from cookie" do
65	get '/'
66	assert_match %r{<html [^>]class="[^\"]_theme-default}, last_response.body
67	refute_includes last_response.body, '_theme-dark'
68
69	set_cookie('dark=1')
70
71	get '/'
72	assert_match %r{<html [^>]class="[^\"]_theme-dark}, last_response.body
73	refute_includes last_response.body, '_theme-default'
74	end
75	end	46	end
76		47
77	describe "/[static-page]" do	48	describe "/[static-page]" do
@@ -106,58 +77,6 @@ class AppTest < MiniTest::Spec · 28 unmodified lines
106	end	77	end
107	end	78	end
108		79
109	describe "/manifest.appcache" do
110	it "works" do
111	get '/manifest.appcache'
112	assert last_response.ok?
113	end
114
115	it "works with cookie" do
116	set_cookie('docs=css/html~5')
117	get '/manifest.appcache'
118	assert last_response.ok?
119	assert_includes last_response.body, '/css/index.json?1420139788'
120	assert_includes last_response.body, '/html~5/index.json?1420139791'
121	end
122
123	it "ignores invalid docs in the cookie" do
124	set_cookie('docs=foo')
125	get '/manifest.appcache'
126	assert last_response.ok?
127	refute_includes last_response.body, 'foo'
128	end
129
130	it "has the word 'default' when no 'dark' cookie is set" do
131	get '/manifest.appcache'
132	assert_includes last_response.body, '# default'
133	refute_includes last_response.body, '# dark'
134	end
135
136	it "has the word 'dark' when the cookie is set" do
137	set_cookie('dark=1')
138	get '/manifest.appcache'
139	assert_includes last_response.body, '# dark'
140	refute_includes last_response.body, '# default'
141	end
142
143	it "sets default size" do
144	get '/manifest.appcache'
145	assert_includes last_response.body, '20rem'
146	end
147
148	it "sets size from cookie" do
149	set_cookie('size=42')
150	get '/manifest.appcache'
151	assert_includes last_response.body, '42px'
152	end
153
154	it "sets layout from cookie" do
155	set_cookie('layout=foo_layout')
156	get '/manifest.appcache'
157	assert_includes last_response.body, 'foo_layout'
158	end
159	end
160
161	describe "/[doc]" do	80	describe "/[doc]" do
162	it "renders when the doc exists and isn't enabled" do	81	it "renders when the doc exists and isn't enabled" do
163	set_cookie('docs=html~5')	82	set_cookie('docs=html~5')

test/lib/docs/core/scrapers/file_scraper_test.rb+2−2

@@ -63,7 +63,7 @@ class FileScraperTest < MiniTest::Spec · 62 unmodified lines
63	end	63	end
64		64
65	it "reads a file" do	65	it "reads a file" do
66	mock(scraper).read_file(path)	66	mock(scraper).read_file(File.join(ROOT_PATH, 'docs/scraper', path))
67	result	67	result
68	end	68	end
69		69
@@ -165,7 +165,7 @@ class FileScraperTest < MiniTest::Spec · 95 unmodified lines
165		165
166	describe "#read_file" do	166	describe "#read_file" do
167	let :result do	167	let :result do
168	scraper.send :read_file, 'file'	168	scraper.send :read_file, File.join(ROOT_PATH, 'docs', 'scraper', 'file')
169	end	169	end
170		170
171	it "returns the file's content when the file exists in the source directory" do	171	it "returns the file's content when the file exists in the source directory" do

views/app.erb+1−13

@@ -28,13 +28,7 @@ · 27 unmodified lines
28	</nav>	28	</nav>
29	</header>	29	</header>
30	<section class="_sidebar" tabindex="-1">	30	<section class="_sidebar" tabindex="-1">
31	<div class="_list" role="navigation">	31	<div class="_list" role="navigation"></div>
32	<% unless @doc %>
33	<% App.docs.each do \|slug, doc\| %>
34	<a href="/<%= slug %>/" class="_list-item"><%= doc['full_name'] %></a>
35	<% end %>
36	<% end %>
37	</div>
38	</section>	32	</section>
39	<div class="_container" role="document">	33	<div class="_container" role="document">
40	<main class="_content _content-loading" role="main"></main>	34	<main class="_content _content-loading" role="main"></main>
@@ -63,9 +57,3 @@ · 22 unmodified lines
63	<symbol id="icon-external-link" viewBox="0 0 24 24"><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></symbol>	57	<symbol id="icon-external-link" viewBox="0 0 24 24"><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></symbol>
64	</defs>	58	</defs>
65	</svg>	59	</svg>
66	<style data-size="<%= app_size %>" data-resizer>
67	._container { margin-left: <%= app_size %>; }
68	._header, ._list { width: <%= app_size %>; }
69	._list-hover.clone { min-width: <%= app_size %>; }
70	._notice, ._path, ._resizer { left: <%= app_size %>; }
71	</style>

views/index.erb+3−2

 <!DOCTYPE html>
-<html<%= ' manifest="/manifest.appcache"' if App.production? %> prefix="og: http://ogp.me/ns#" lang="en" class="_booting _theme-<%= app_theme %>">
+<html prefix="og: http://ogp.me/ns#" lang="en" class="_booting">
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no,shrink-to-fit=no">
   <meta name="apple-mobile-web-app-capable" content="yes">
   <meta name="apple-mobile-web-app-status-bar-style" content="black">
   <meta name="format-detection" content="telephone=no">
+  <meta name="theme-color" content="#eee">
   <meta name="robots" content="noodp">
   <title>DevDocs API Documentation</title>
   <link rel="canonical" href="<%= canonical_origin %>">
   <link rel="mask-icon" href="<%= App.cdn_origin %>/images/webkit-mask-icon.svg" color="#398df0">
   <%= stylesheet_tag 'application' %>
 </head>
-<body<%= %( class="#{app_layout}") if app_layout %>>
+<body>
 <noscript class="_fail">DevDocs requires JavaScript to run.</noscript>
 <%= erb :app -%>
 <%= javascript_tag 'application', asset_host: false %>

views/manifest.erb+0−14

@@ -1,14 +0,0 @@
1	CACHE MANIFEST
2	# <%= app_theme %> <%= app_size %> <%= app_layout %>
3
4	CACHE:
5	/
6	<%= manifest_asset_urls.join "\n" %>
7	<%= doc_index_urls.join "\n" %>
8
9	NETWORK:
10	/s/
11	*
12
13	FALLBACK:
14	/ /

views/other.erb+3−2

 <!DOCTYPE html>
-<html lang="en" class="_booting _theme-<%= app_theme %>">
+<html lang="en" class="_booting">
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no">
   <% if doc_index_page? %><meta name="description" content="<%= @doc['name'] %> <%= @doc['release'] %> API documentation with instant search, offline support, keyboard shortcuts, mobile version, and more."><% else %><meta name="robots" content="noindex"><% end %>
   <meta name="format-detection" content="telephone=no">
+  <meta name="theme-color" content="#eee">
   <meta property="og:image" content="<%= App.cdn_origin %>/images/icon-320.png">
   <title>DevDocs<%= " &mdash; #{@doc['full_name']} documentation" if doc_index_page? %></title>
   <link rel="canonical" href="<%= canonical_origin %><%= request.path %>">
   <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Search DevDocs">
   <%= stylesheet_tag 'application' %>
 </head>
-<body<%= %( class="#{app_layout}") if app_layout %> data-doc="<%= CGI::escape_html @doc.to_json %>">
+<body data-doc="<%= CGI::escape_html @doc.to_json %>">
 <noscript class="_fail">DevDocs requires JavaScript to run.</noscript>
 <%= erb :app -%>
 <%= javascript_tag 'application', asset_host: false %><% unless App.production? %>

views/service-worker.js.erb+49−0

@@ -0,0 +1,49 @@
	1	<%# The name of the cache to store responses in %>
	2	<%# If the cache name changes DevDocs is assumed to be updated %>
	3	const cacheName = '<%= service_worker_cache_name %>';
	4
	5	<%# Url's to cache when the service worker is installed %>
	6	const urlsToCache = [
	7	'/',
	8	'/favicon.ico',
	9	'/manifest.json',
	10	'<%= service_worker_asset_urls.join "',\n '" %>',
	11	'<%= doc_index_urls.join "',\n '" %>',
	12	];
	13
	14	<%# Set-up the cache %>
	15	self.addEventListener('install', event => {
	16	self.skipWaiting();
	17
	18	event.waitUntil(
	19	caches.open(cacheName).then(cache => cache.addAll(urlsToCache)),
	20	);
	21	});
	22
	23	<%# Remove old caches %>
	24	self.addEventListener('activate', event => {
	25	event.waitUntil((async () => {
	26	const keys = await caches.keys();
	27	const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve());
	28	return Promise.all(jobs);
	29	})());
	30	});
	31
	32	<%# Handle HTTP requests %>
	33	self.addEventListener('fetch', event => {
	34	event.respondWith((async () => {
	35	const cachedResponse = await caches.match(event.request);
	36	if (cachedResponse) return cachedResponse;
	37
	38	const url = new URL(event.request.url);
	39
	40	<%# 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 %>
	41	<%# The index page will handle the routing %>
	42	if (url.origin === location.origin && !url.pathname.includes('.')) {
	43	const cachedIndex = await caches.match('/');
	44	if (cachedIndex) return cachedIndex;
	45	}
	46
	47	return fetch(event.request);
	48	})());
	49	});

views/unsupported.erb+3−3

@@ -11,9 +11,9 @@ · 10 unmodified lines
11	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:</p>	11	<p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:</p>
12	<ul class="_fail-list">	12	<ul class="_fail-list">
13	<li>Recent versions of Firefox, Chrome, or Opera</li>	13	<li>Recent versions of Firefox, Chrome, or Opera</li>
14	<li>Safari 9.1+</li>	14	<li>Safari 11.1+</li>
15	<li>Edge 16+</li>	15	<li>Edge 17+</li>
16	<li>iOS 10+</li>	16	<li>iOS 11.3+</li>
17	</ul>	17	</ul>
18	<p class="_fail-text">	18	<p class="_fail-text">
19	If you're unable to upgrade, we apologize.	19	If you're unable to upgrade, we apologize.

@@ -59,14 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff · 58 unmodified lines
59		59
60	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.	60	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.
61		61
62	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.	62	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.
63		63
64	DevDocs being a developer tool, the browser requirements are high:	64	DevDocs being a developer tool, the browser requirements are high:
65		65
66	* Recent versions of Firefox, Chrome, or Opera	66	* Recent versions of Firefox, Chrome, or Opera
67	* Safari 9.1+	67	* Safari 11.1+
68	* Edge 16+	68	* Edge 17+
69	* iOS 10+	69	* iOS 11.3+
70		70
71	This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!	71	This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!
72		72
@@ -156,7 +156,7 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C · 83 unmodified lines
156	* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets	156	* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets
157	* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar	157	* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar
158	* [macOS Application](https://github.com/dteoh/devdocs-macos)	158	* [macOS Application](https://github.com/dteoh/devdocs-macos)
159	* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView with AppCache enabled	159	* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView
160		160
161	## Copyright / License	161	## Copyright / License
162		162

@@ -8,7 +8,7 @@ app.templates.intro = """ · 7 unmodified lines
8	<p>Thanks for downloading DevDocs. Here are a few things you should know:	8	<p>Thanks for downloading DevDocs. Here are a few things you should know:
9	<ol class="_intro-list">	9	<ol class="_intro-list">
10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,	10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,
11	I recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.	11	we recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.
12	<li>Run <code>thor docs:list</code> to see all available documentations.	12	<li>Run <code>thor docs:list</code> to see all available documentations.
13	<li>Run <code>thor docs:download <name></code> to download documentations.	13	<li>Run <code>thor docs:download <name></code> to download documentations.
14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.	14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
@@ -39,7 +39,7 @@ app.templates.intro = """ · 24 unmodified lines
39	<li>DevDocs works <a href="/offline">offline</a>, on mobile, and can be installed on <a href="https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe">Chrome</a>.	39	<li>DevDocs works <a href="/offline">offline</a>, on mobile, and can be installed on <a href="https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe">Chrome</a>.
40	<li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.	40	<li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
41	<li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.	41	<li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
42	<iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>	42	<object data="https://img.shields.io/github/stars/freeCodeCamp/devdocs.svg?style=social" type="image/svg+xml" aria-hidden="true"></object>
43	<li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>.	43	<li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>.
44	</ol>	44	</ol>
45	<p>Happy coding!	45	<p>Happy coding!