From 9baef9a8875d6b638f00c2960908fe39a1896a71 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Thu, 24 Oct 2013 11:38:59 -0700
Subject: [PATCH 01/54] Initial Commit

---
 Home.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 Home.md

diff --git a/Home.md b/Home.md
new file mode 100644
index 00000000..7d6544a4
--- /dev/null
+++ b/Home.md
@@ -0,0 +1 @@
+Welcome to the devdocs wiki!
\ No newline at end of file

From 0cb6cb918c78be179a9c5ddbb34f9a2b6e3a1c83 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Fri, 8 Nov 2013 11:33:53 -0800
Subject: [PATCH 02/54] Created Adding documentations to DevDocs (markdown)

---
 Adding-documentations-to-DevDocs.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 Adding-documentations-to-DevDocs.md

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
new file mode 100644
index 00000000..66eb5f24
--- /dev/null
+++ b/Adding-documentations-to-DevDocs.md
@@ -0,0 +1,27 @@
+---
+
+Adding a documentation may look like a daunting task but once you get the hang of it, it's actually quite simple. Don't hesitate to ask for help on the [mailing list](https://groups.google.com/d/forum/devdocs) if you ever get stuck.
+
+**Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md) before submitting a new documentation.
+
+1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
+2. Add the appropriate class attributes and filter options (see the [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference) page).
+3. Check that the scraper is listed in `thor docs:list`.
+4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks). You may create any number of filters but will need at least the following two:
+   * A [`CleanHtml`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential.
+   * An [`Entries`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter) filter whose task is to determine the pages' metadata (the list of entries, each with a name, type and path).
+   The [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference) page has all the details about filters.
+5. Using the `thor docs:page [my_doc] [path]` command, check that the scraper works properly. Files will appear in the `public/docs/[my_doc]/` directory (but not inside the app as the command doesn't touch the index).
+6. Generate the full documentation using the `thor docs:download [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
+7. Start the server, open the app, enable the documentation, and see how everything plays out.
+8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.
+9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in `application.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). _(Note: feel free to submit a pull request without custom CSS/JS)_
+10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the `assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
+11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. It'll be added to the icon sprite after your pull request is merged.
+
+If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
+
+Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
+
+---
+_Feel free to edit this page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file

From 6f3be073212c9063d78557d95806f65112ac615a Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Fri, 8 Nov 2013 11:34:30 -0800
Subject: [PATCH 03/54] Created Scraper Reference (markdown)

---
 Scraper-Reference.md | 182 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 182 insertions(+)
 create mode 100644 Scraper-Reference.md

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
new file mode 100644
index 00000000..96bec984
--- /dev/null
+++ b/Scraper-Reference.md
@@ -0,0 +1,182 @@
+---
+
+**Table of contents:**
+
+* [Overview](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#overview)
+* [Configuration](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#configuration)
+  - [Attributes](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#attributes)
+  - [Filter stacks](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks)
+  - [Filter options](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-options)
+
+## Overview
+
+Starting from a root url, scrapers recursively follow links that match a set of rules, passing each valid response through a chain of filters before writing the file on the local filesystem. They also create an index of the pages' metadata (determined by one filter), which is dumped into a JSON file at the end.
+
+Scrapers rely on the following libraries:
+
+* [Typhoeus](https://github.com/typhoeus/typhoeus) for making HTTP requests
+* [HTML::Pipeline](https://github.com/jch/html-pipeline) for applying filters
+* [Nokogiri](http://nokogiri.org/) for parsing HTML
+
+There are currently two kinds of scrapers: [`UrlScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/url_scraper.rb) which downloads files via HTTP and [`FileScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/file_scraper.rb) which reads them from the local filesystem. They function almost identically (both use URLs), except that `FileScraper` substitutes the base url with a local path before reading a file.
+
+To be processed, a response must meet the following requirements:
+
+* 200 status code
+* HTML content type
+* effective URL (after redirection) contained in the base url (explained below)
+
+(`FileScraper` only checks if the file exists and is not empty.)
+
+Each URL is requested only once (case-insensitive).
+
+## Configuration
+
+Configuration is done via class attributes and divided into three main categories:
+
+* [Attributes](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#attributes) — essential information such as name, version, url, etc.
+* [Filter stacks](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks) — the list of filters that will be applied to each page.
+* [Filter options](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-options) — the options passed to said filters.
+
+**Note:** scrapers are located in the [`lib/docs/scrapers`](https://github.com/Thibaut/devdocs/tree/master/lib/docs/scrapers/) directory. The class's name must be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename.
+
+### Attributes
+
+* `name` [String]  
+  Must be unique.  
+  Defaults to the class's name.
+
+* `slug` [String]  
+  Must be unique, lowercase, and not include dashes (underscores are ok).  
+  Defaults to `name` lowercased.
+
+* `type` [String] **(required, inherited)**  
+  Defines the CSS class name (`_[type]`) and custom JavaScript class (`app.views.[Type]Page`) that will be added/loaded on each page. Documentations sharing a similar structure (e.g. generated with the same tool or originating from the same website) should use the same `type` to avoid duplicating the CSS and JS.  
+  Must include lowercase letters only.
+
+* `version` [String] **(required)**  
+  The version of the software at the time the scraper was last run. This is only informational and doesn't affect the scraper's behavior.
+
+* `base_url` [String] **(required)**  
+  The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
+  Unless `root_path` is set, the root/initial URL is equal to `base_url`.
+
+* `root_path` [String]  
+  The path from the `base_url` of the root URL.
+
+* `dir` [String] **(required, `FileScraper` only)**  
+  The absolute path where the files are located on the local filesystem.  
+  _Note: `FileScraper` works exactly like `UrlScraper` (manipulating the same kind of URLs) except that it substitutes `base_url` with `dir` in order to read files instead of making HTTP requests._
+
+* `params` [Hash] **(inherited, `UrlScraper` only)**  
+  Query string parameters to append to every URL. (e.g. `{ format: 'raw' }` → `?format=raw`)  
+  Defaults to `{}`.
+
+* `abstract` [Boolean]  
+  Make the scraper abstract / not runnable. Used for sharing behavior with other scraper classes (e.g. all MDN scrapers inherit from the abstract [`Mdn`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/scrapers/mdn/mdn.rb) class).  
+  Defaults to `false`.
+
+### Filter stacks
+
+Each scraper has two [filter](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter.rb) [stacks](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter_stack.rb): `html_filters` and `text_filters`. They are combined into a pipeline (using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library) which causes each filter to hand its output to the next filter's input.
+
+HTML filters are executed first and manipulate a parsed version of the document (a [Nokogiri](http://nokogiri.org/Nokogiri/XML/Node.html) node object), whereas text filters manipulate the document as a string. This separation avoids parsing the document multiple times.
+
+Filter stacks are like sorted sets. They can modified using the following methods:
+
+```
+push(*names)                 # append one or more filters at the end
+insert_before(index, *names) # insert one filter before another (index can be a name)
+insert_after(index, *names)  # insert one filter after another (index can be a name)
+replace(index, name)         # replace one filter with another (index can be a name)
+```
+
+"names" are `require` paths relative to `Docs` (e.g. `jquery/clean_html` → `Docs::Jquery::CleanHtml`).
+
+Default `html_filters`:
+
+* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside)
+* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc.
+* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
+* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
+* [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
+
+Default `text_filters`:
+
+* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string
+* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes
+* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document
+
+Additionally:
+
+* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) is a core HTML filter, disabled by default, which prepends the document with a title (`<h1>`).
+* [`EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) is an abstract HTML filter that each scraper must implement and responsible for extracting the page's metadata.
+
+### Filter options
+
+The filter options are stored in the `options` Hash. The Hash is inheritable (a recursive copy) and empty by default.
+
+More information about how filters work is available on the [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference) page.
+
+* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb)
+
+  - `:container` [String or Proc]  
+    A CSS selector of the container element. Everything outside of it will be removed and become unavailable to the other filters. If more than one element match the selector, the first one inside the DOM is used. If no elements match the selector, an error is raised.  
+    If the value is a Proc, it is called repeatedly for each page, with the filter instance as argument, and should return a selector or `nil`.  
+    The default container is the `<body>` element.  
+    _Note: links outside of the container element will not be followed by the scraper. To remove links that should be followed, use a [`CleanHtml`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#cleanhtmlfilter) filter later in the stack._
+
+* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb)  
+  The following options are used to modify URLs in the pages. They are useful to remove duplicates (when the same page is accessible from multiple URLs) and fix websites that have a bunch of redirections in place (when URLs that should be scraped, aren't, because they are behind a redirection which is outside of the `base_url` — see the MDN scrapers for examples of this).
+  
+  - `:replace_urls` [Hash]  
+    Replaces all instances of a URL with another.  
+    Format: `{ 'original_url' => 'new_url' }`
+  - `:replace_paths` [Hash]  
+    Replaces all instances of a sub-path (path from the `base_url`) with another.  
+    Format: `{ 'original_path' => 'new_path' }`
+  - `:fix_urls` [Proc]  
+    Called with each URL. If the returned value is `nil`, the URL isn't modified. Otherwise the returned value is used as replacement.
+    
+  _Note: before these rules are applied, all URLs are converted to their fully qualified counterpart (http://...)._
+
+* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb)
+
+  Internal URLs are the ones _inside_ the scraper's `base_url` ("inside" more or less means "starting with", except that `/docs` is outside `/doc`). They will be scraped unless excluded by one of the following rules. All internal URLs are converted to relative URLs inside the pages.
+
+  - `:trailing_slash` [Boolean]  
+    If `true`, adds a trailing slash to all internal URLs. If `false`, removes it.  
+    This is another option used to remove duplicate pages.
+  - `:skip_links` [Proc]  
+    Called with each `<a>` node. If the returned value is `true`, the link is skipped and its URL ignored.
+  - `:skip` [Array]  
+    Ignores internal URLs whose sub-paths (path from the `base_url`) are in the Array (case-insensitive).
+  - `:skip_patterns` [Array]  
+    Ignores internal URLs whose sub-paths match any Regexp in the Array.
+  - `:only` [Array]  
+    Ignores internal URLs whose sub-paths aren't in the Array (case-insensitive) and don't match any Regexp in `:only_patterns`.
+  - `:only_patterns` [Array]  
+    Ignores internal URLs whose sub-paths don't match any Regexp in the Array and aren't in `:only`.
+
+  If the scraper has a `root_path`, the empty and `/` paths are automatically skipped.  
+  If `:only` or `:only_patterns` is set, the root path is automatically added to `:only`.
+
+  _Note: pages can be excluded from the index based on their content using the [`Entries`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter) filter. However, their URLs will still be converted to relative in the other pages and trying to open them will return a 404 error. Although not ideal, this is often better than having to maintain a long list of `:skip` URLs._
+
+* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb)
+
+  - `:attribution` [String] **(required)**  
+    An HTML string with the copyright and license information. See the other scrapers for examples.
+
+* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb)
+
+  - `:title` [String or Boolean or Proc]  
+    Unless the value is `false`, adds a title to every page.  
+    If the value is `nil`, the title is the name of the page as determined by the [`Entries`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter) filter. Otherwise the title is the String or the value returned by the Proc (called for each page, with the filter instance as argument). If the Proc returns `nil` or `false`, no title is added.
+  - `:root_title` [String or Boolean]  
+    Overrides the `:title` option for the root page only.
+
+  _Note: this filter is disabled by default._
+
+---
+_Feel free to edit wiki page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file

From 91ef8e774eec2d9847fe629e86fc876c1361af35 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Fri, 8 Nov 2013 11:34:41 -0800
Subject: [PATCH 04/54] Created Filter Reference (markdown)

---
 Filter-Reference.md | 222 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 222 insertions(+)
 create mode 100644 Filter-Reference.md

diff --git a/Filter-Reference.md b/Filter-Reference.md
new file mode 100644
index 00000000..0bb5ba9d
--- /dev/null
+++ b/Filter-Reference.md
@@ -0,0 +1,222 @@
+---
+
+**Table of contents:**
+
+* [Overview](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#overview)
+* [Instance methods](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#instance-methods)
+* [Core filters](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#core-filters)
+* [Custom filters](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#custom-filters)
+  - [CleanHtmlFilter](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#cleanhtmlfilter)
+  - [EntriesFilter](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter)
+
+## Overview
+
+Filters use the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. They take an HTML string or [Nokogiri](http://nokogiri.org/) node as input, optionally perform modifications and/or extract information from it, and then outputs the result. Together they form a pipeline where each filter hands its output to the next filter's input. Every documentation page passes through this pipeline before being copied on the local filesystem.
+
+Filters are subclasses of the [`Docs::Filter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/filter.rb) class and require a `call` method. A basic implementation looks like this:
+
+```ruby
+module Docs
+  class CustomFilter < Filter
+    def call
+      doc
+    end
+  end
+end
+```
+
+Filters which manipulate the Nokogiri node object (`doc` and related methods) are _HTML filters_ and must not manipulate the HTML string (`html`). Vice-versa, filters which manipulate the string representation of the document are _text filters_ and must not manipulate the Nokogiri node object. The two types are divided into two stacks within the scrapers. These stacks are then combined into a pipeline that calls the HTML filters before the text filters (more details [here](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks)). This is to avoid parsing the document multiple times.
+
+The `call` method must return either `doc` or `html`, depending on the type of filter.
+
+## Instance methods
+
+* `doc` [Nokogiri::XML::Node]  
+  The Nokogiri representation of the container element.  
+  See [Nokogiri's API docs](http://nokogiri.org/Nokogiri/XML/Node.html#methods_nav) for the list of available methods.
+
+* `html` [String]  
+  The string representation of the container element.
+  
+* `context` [Hash] **(frozen)**  
+  The scraper's `options` along with a few additional keys: `:base_url`, `:root_url`, `:root_page` and `:url`.
+
+* `result` [Hash]  
+  Used to store the page's metadata and pass back information to the scraper.  
+  Possible keys:
+  
+  - `:path` — the page's normalized path
+  - `:store_path` — the path where the page will be stored (equal to `:path` with `.html` at the end)
+  - `:internal_urls` — the list of distinct internal URLs found within the page
+  - `:entries` — the [`Entry`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb) objects to add to the index
+
+* `css`, `at_css`, `xpath`, `at_xpath`  
+  Shortcuts for `doc.css`, `doc.xpath`, etc.
+
+* `base_url`, `current_url`, `root_url` [Docs::URL]  
+  Shortcuts for `context[:base_url]`, `context[:url]`, and `context[:root_url]` respectively.
+  
+* `root_path` [String]  
+  Shortcut for `context[:root_path]`.
+
+* `subpath` [String]  
+  The sub-path from the base URL of the current URL.  
+  _Example: if `base_url` equals `example.com/docs` and `current_url` equals `example.com/docs/file?raw`, the returned value is `/file`._
+
+* `slug` [String]  
+  The `subpath` removed of any leading slash or `.html` extension.  
+  _Example: if `subpath` equals `/dir/file.html`, the returned value is `dir/file`._
+
+* `root_page?` [Boolean]  
+  Returns `true` if the current page is the root page.
+
+## Core filters
+
+* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside)
+* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc.
+* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
+* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
+* [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
+* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string
+* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes
+* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document
+* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) — prepends the document with a title (disabled by default)
+* [`EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) — abstract filter for extracting the page's metadata
+
+## Custom filters
+
+Scrapers can have any number of custom filters but require at least the two described below.
+
+**Note:** filters are located in the [`lib/docs/filters`](https://github.com/Thibaut/devdocs/tree/master/lib/docs/filters/) directory. The class's name must be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename.
+
+### `CleanHtmlFilter`
+
+The `CleanHtml` filter is tasked with cleaning the HTML markup where necessary and removing anything superfluous or nonessential. Only the core documentation should remain at the end.
+
+Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](http://nokogiri.org/Nokogiri/XML/Node.html#methods_nav).
+
+Here's an example implementation that covers the most common use-cases:
+
+```ruby
+module Docs
+  class MyScraper
+    class CleanHtmlFilter < Filter
+      def call
+        css('hr').remove
+        css('#changelog').remove if root_page?
+
+        # Set id attributes on <h3> instead of an empty <a>
+        css('h3').each do |node|
+          node['id'] = node.at_css('a')['id']
+        end
+
+        # Make proper table headers
+        css('td.header').each do |node|
+          node.name = 'th'
+        end
+
+        # Remove code highlighting
+        css('pre').each do |node|
+          node.content = node.content
+        end
+
+        doc
+      end
+    end
+  end
+end
+```
+
+**Notes:**
+
+* Empty elements will be automatically removed by the core `CleanTextFilter` later in the pipeline's execution.
+* Although the goal is to end up with a clean version of the page, try to keep the number of modifications to a minimum, so as to make the code easier to maintain. Custom CSS is the preferred way of normalizing the pages (except for hiding stuff which should always be done by removing the markup).
+* Try to document your filter's behavior as much as possible, particularly modifications that apply only to a subset of pages. It'll make updating the documentation easier.
+
+### `EntriesFilter`
+
+The `Entries` filter is responsible for extracting the page's metadata, represented by a set of _entries_, each with a name, type and path.
+
+The following two models are used under the hood to represent the metadata:
+
+* [`Entry(name, type, path)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb)
+* [`Type(name, slug, count)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/type.rb)
+
+Each scraper must implement its own `EntriesFilter` by subclassing the [`Docs::EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) class. The base class already implements the `call` method and includes four methods which the subclasses can override:
+
+* `get_name` [String]  
+  The name of the default entry (aka. the page's name).  
+  It is usually guessed from the `slug` (documented above) or by searching the HTML markup.  
+  **Default:** modified version of `slug` (underscores are replaced with spaces and forward slashes with dots)
+
+* `get_type` [String]  
+  The type of the default entry (aka. the page's type).  
+  Entries without a type can be searched for but won't be listed in the app's sidebar (unless no other entries have a type).  
+  **Default:** `nil`
+
+* `include_default_entry?` [Boolean]  
+  Whether to include the default entry.  
+  Used when a page consists of multiple entries (returned by `additional_entries`) but doesn't have a name/type of its own, or to remove a page from the index (if it has no additional entries), in which case it won't be copied on the local filesystem and any link to it in the other pages will be broken (as explained on the [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference) page, this is used to keep the `:skip` / `:skip_patterns` options to a maintainable size, or if the page includes links that can't reached from anywhere else).  
+  **Default:** `true`
+
+* `additional_entries` [Array]  
+  The list of additional entries.  
+  Each entry is represented by an Array of three attributes: its name, fragment identifier, and type. The fragment identifier refers to the `id` attribute of the HTML element (usually a heading) that the entry relates to. It is combined with the page's path to become the entry's path. If absent or `nil`, the page's path is used. If the type is absent or `nil`, the default `type` is used.  
+  Example: `[ ['One'], ['Two', 'id'], ['Three', nil, 'type'] ]` adds three additional entries, the first one named "One" with the default path and type, the second one named "Two" with the URL fragment "#id" and the default type, and the third one named "Three" with the default path and the type "type".  
+  The list is usually constructed by running through the markup. Exceptions can also be hard-coded for specific pages.  
+  **Default:** `[]`
+
+The following accessors are also available, but must not be overridden:
+
+* `name` [String]  
+  Memoized version of `get_name` (`nil` for the root page).
+
+* `type` [String]  
+  Memoized version of `get_type` (`nil` for the root page).
+
+**Notes:**
+
+* Leading and trailing whitespace is automatically removed from names and types.
+* Names must be unique across the documentation and as short as possible (ideally less than 30 characters). Whenever possible, methods should be differentiated from properties by appending `()`, and instance methods should be differentiated from class methods using the `Class#method` or `object.method` conventions.
+* You can call `name` from `get_type` or `type` from `get_name` but doing both will cause a stack overflow (i.e. you can infer the name from the type or the type from the name, but you can't do both at the same time). Don't call `get_name` or `get_type` directly as their value isn't memoized.
+* The root page has no name and no type (both are `nil`). `get_name` and `get_type` won't get called with the page (but `additional_entries` will).
+* `Docs::EntriesFilter` is an _HTML filter_. It must be added to the scraper's `html_filters` stack.
+* Try to document the code as much as possible, particularly the special cases. It'll make updating the documentation easier.
+
+**Example:**
+
+```ruby
+module Docs
+  class MyScraper
+    class EntriesFilter < Docs::EntriesFilter
+      def get_name
+        node = at_css('h1')
+        result = node.content.strip
+        result << ' event' if type == 'Events'
+        result << '()' if node['class'].try(:include?, 'function')
+        result
+      end
+
+      def get_type
+        object, method = *slug.split('/')
+        method ? object : 'Miscellaneous'
+      end
+
+      def additional_entries
+        return [] if root_page?
+
+        css('h2').map do |node|
+          [node.content, node['id']]
+        end
+      end
+
+      def include_default_entry?
+        !at_css('.obsolete')
+      end
+    end
+  end
+end
+```
+
+---
+_Feel free to edit this page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file

From 0884dcc8212a138c4cdf68fe5e152a35dba668c1 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Fri, 8 Nov 2013 11:37:10 -0800
Subject: [PATCH 05/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 96bec984..7c1e511d 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -84,7 +84,7 @@ HTML filters are executed first and manipulate a parsed version of the document
 
 Filter stacks are like sorted sets. They can modified using the following methods:
 
-```
+```ruby
 push(*names)                 # append one or more filters at the end
 insert_before(index, *names) # insert one filter before another (index can be a name)
 insert_after(index, *names)  # insert one filter after another (index can be a name)

From 788ce7abcf17dbfcea67a000f809c957250de778 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Fri, 8 Nov 2013 11:39:21 -0800
Subject: [PATCH 06/54] Updated Home (markdown)

---
 Home.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 7d6544a4..44d78a86 100644
--- a/Home.md
+++ b/Home.md
@@ -1 +1,3 @@
-Welcome to the devdocs wiki!
\ No newline at end of file
+* [Adding documentations to DevDocs](https://github.com/Thibaut/devdocs/wiki/Adding-documentations-to-DevDocs)
+* [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference)
+* [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference)
\ No newline at end of file

From a482b793cc5e92daa896f3bd13f80e45b2541349 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 9 Nov 2013 02:57:35 -0800
Subject: [PATCH 07/54] Updated Home (markdown)

---
 Home.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 44d78a86..a50130f6 100644
--- a/Home.md
+++ b/Home.md
@@ -1,3 +1,11 @@
+### Development
+
 * [Adding documentations to DevDocs](https://github.com/Thibaut/devdocs/wiki/Adding-documentations-to-DevDocs)
 * [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference)
-* [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference)
\ No newline at end of file
+* [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference)
+
+### Plugins and Extensions
+
+* [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
+* [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
+* [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
\ No newline at end of file

From 3c26efb6638d775bf24cc1f0463c81ddee81d6ac Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 12 Nov 2013 05:24:15 -0800
Subject: [PATCH 08/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 7c1e511d..d08f7e52 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -61,7 +61,7 @@ Configuration is done via class attributes and divided into three main categorie
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
-* `root_path` [String]  
+* `root_path` [String] **(inherited)**  
   The path from the `base_url` of the root URL.
 
 * `dir` [String] **(required, `FileScraper` only)**  

From 0caa366d755785fc2a3c6241eaf846e824baf02e Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:10:56 -0800
Subject: [PATCH 09/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index d08f7e52..d9622e3a 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -57,7 +57,7 @@ Configuration is done via class attributes and divided into three main categorie
 * `version` [String] **(required)**  
   The version of the software at the time the scraper was last run. This is only informational and doesn't affect the scraper's behavior.
 
-* `base_url` [String] **(required)**  
+* `base_url` [String] **(required in `UrlScraper`)**  
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
@@ -100,6 +100,7 @@ Default `html_filters`:
 * [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
 * [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
 * [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
+* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — remove links, iframes and images pointing to localhost (`FileScraper` only)
 
 Default `text_filters`:
 

From a8ffebca24aa9119da55a80f8f31849ac9c485c2 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:38:08 -0800
Subject: [PATCH 10/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index d9622e3a..feed7b4c 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -10,7 +10,7 @@
 
 ## Overview
 
-Starting from a root url, scrapers recursively follow links that match a set of rules, passing each valid response through a chain of filters before writing the file on the local filesystem. They also create an index of the pages' metadata (determined by one filter), which is dumped into a JSON file at the end.
+Starting from a root URL, scrapers recursively follow links that match a set of rules, passing each valid response through a chain of filters before writing the file on the local filesystem. They also create an index of the pages' metadata (determined by one filter), which is dumped into a JSON file at the end.
 
 Scrapers rely on the following libraries:
 
@@ -18,13 +18,13 @@ Scrapers rely on the following libraries:
 * [HTML::Pipeline](https://github.com/jch/html-pipeline) for applying filters
 * [Nokogiri](http://nokogiri.org/) for parsing HTML
 
-There are currently two kinds of scrapers: [`UrlScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/url_scraper.rb) which downloads files via HTTP and [`FileScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/file_scraper.rb) which reads them from the local filesystem. They function almost identically (both use URLs), except that `FileScraper` substitutes the base url with a local path before reading a file.
+There are currently two kinds of scrapers: [`UrlScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/url_scraper.rb) which downloads files via HTTP and [`FileScraper`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/scrapers/file_scraper.rb) which reads them from the local filesystem. They function almost identically (both use URLs), except that `FileScraper` substitutes the base URL with a local path before reading a file. `FileScraper` uses the placeholder `localhost` base URL by default and includes a filter to remove any URL pointing to it at the end.
 
 To be processed, a response must meet the following requirements:
 
 * 200 status code
 * HTML content type
-* effective URL (after redirection) contained in the base url (explained below)
+* effective URL (after redirection) contained in the base URL (explained below)
 
 (`FileScraper` only checks if the file exists and is not empty.)
 
@@ -34,7 +34,7 @@ Each URL is requested only once (case-insensitive).
 
 Configuration is done via class attributes and divided into three main categories:
 
-* [Attributes](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#attributes) — essential information such as name, version, url, etc.
+* [Attributes](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#attributes) — essential information such as name, version, URL, etc.
 * [Filter stacks](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks) — the list of filters that will be applied to each page.
 * [Filter options](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-options) — the options passed to said filters.
 
@@ -59,6 +59,7 @@ Configuration is done via class attributes and divided into three main categorie
 
 * `base_url` [String] **(required in `UrlScraper`)**  
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
+   `FileScraper`'s default is `localhost`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
 * `root_path` [String] **(inherited)**  

From 09c71d78f6465ebbc5c198274c027066c2c0788a Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:40:06 -0800
Subject: [PATCH 11/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index feed7b4c..ea0c206e 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -59,7 +59,7 @@ Configuration is done via class attributes and divided into three main categorie
 
 * `base_url` [String] **(required in `UrlScraper`)**  
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
-   `FileScraper`'s default is `localhost`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)
+   Defaults to `localhost` in `FileScraper`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
 * `root_path` [String] **(inherited)**  

From 01f225245c6ea32a71d7d328263e264946236219 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:40:46 -0800
Subject: [PATCH 12/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index ea0c206e..59d0c69b 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -59,7 +59,7 @@ Configuration is done via class attributes and divided into three main categorie
 
 * `base_url` [String] **(required in `UrlScraper`)**  
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
-   Defaults to `localhost` in `FileScraper`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)
+   Defaults to `localhost` in `FileScraper`. _(Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)_
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
 * `root_path` [String] **(inherited)**  

From 7f24d9f02e7b6d8c31a5e41bb1bd43d39801f248 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:41:14 -0800
Subject: [PATCH 13/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 59d0c69b..9a157b2f 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -59,7 +59,7 @@ Configuration is done via class attributes and divided into three main categorie
 
 * `base_url` [String] **(required in `UrlScraper`)**  
   The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).  
-   Defaults to `localhost` in `FileScraper`. _(Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)_
+   Defaults to `localhost` in `FileScraper`. _(Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)_  
   Unless `root_path` is set, the root/initial URL is equal to `base_url`.
 
 * `root_path` [String] **(inherited)**  

From 9a5373894931e76580bd9a35e0d8fbdcc6900d53 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:43:06 -0800
Subject: [PATCH 14/54] Updated Filter Reference (markdown)

---
 Filter-Reference.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Filter-Reference.md b/Filter-Reference.md
index 0bb5ba9d..5e852b3f 100644
--- a/Filter-Reference.md
+++ b/Filter-Reference.md
@@ -77,6 +77,7 @@ The `call` method must return either `doc` or `html`, depending on the type of f
 * [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
 * [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
 * [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
+* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — removes links, iframes and images pointing to localhost (`FileScraper` only)
 * [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string
 * [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes
 * [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document

From ac7112d7c8bec579df1bce93ba6b2f256bdcaea7 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 17 Nov 2013 01:43:53 -0800
Subject: [PATCH 15/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 9a157b2f..adafd7b2 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -101,7 +101,7 @@ Default `html_filters`:
 * [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart
 * [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) — detects internal URLs (the ones to scrape) and replaces them with their unqualified, relative counterpart
 * [`NormalizePathsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_paths.rb) — makes the internal paths consistent (e.g. always end with `.html`)
-* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — remove links, iframes and images pointing to localhost (`FileScraper` only)
+* [`CleanLocalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_local_urls.rb) — removes links, iframes and images pointing to localhost (`FileScraper` only)
 
 Default `text_filters`:
 

From a004029514ce6fb4e6c8f82a7e12bb85d1dbcb7d Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Mon, 2 Dec 2013 13:57:06 -0800
Subject: [PATCH 16/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index adafd7b2..65ba94f5 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -124,7 +124,7 @@ More information about how filters work is available on the [Filter Reference](h
 
   - `:container` [String or Proc]  
     A CSS selector of the container element. Everything outside of it will be removed and become unavailable to the other filters. If more than one element match the selector, the first one inside the DOM is used. If no elements match the selector, an error is raised.  
-    If the value is a Proc, it is called repeatedly for each page, with the filter instance as argument, and should return a selector or `nil`.  
+    If the value is a Proc, it is called for each page with the filter instance as argument, and should return a selector or `nil`.  
     The default container is the `<body>` element.  
     _Note: links outside of the container element will not be followed by the scraper. To remove links that should be followed, use a [`CleanHtml`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#cleanhtmlfilter) filter later in the stack._
 
@@ -146,11 +146,14 @@ More information about how filters work is available on the [Filter Reference](h
 
   Internal URLs are the ones _inside_ the scraper's `base_url` ("inside" more or less means "starting with", except that `/docs` is outside `/doc`). They will be scraped unless excluded by one of the following rules. All internal URLs are converted to relative URLs inside the pages.
 
+  - `:skip_links` [Boolean or Proc]  
+    If `false`, does not convert or follow any internal URL (creating a single-page documentation).  
+    If the value is a Proc, it is called for each page with the filter instance as argument.
+  - `:follow_links` [Proc]  
+    Called for page with the filter instance as argument. If the returned value is `false`, does not add internal URLs to the queue.
   - `:trailing_slash` [Boolean]  
     If `true`, adds a trailing slash to all internal URLs. If `false`, removes it.  
     This is another option used to remove duplicate pages.
-  - `:skip_links` [Proc]  
-    Called with each `<a>` node. If the returned value is `true`, the link is skipped and its URL ignored.
   - `:skip` [Array]  
     Ignores internal URLs whose sub-paths (path from the `base_url`) are in the Array (case-insensitive).
   - `:skip_patterns` [Array]  

From 6de2a2fca80f4fb4cc8f07d31d4bb8f73d7c768a Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Thu, 12 Dec 2013 08:48:56 -0800
Subject: [PATCH 17/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 65ba94f5..6a117395 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -65,6 +65,10 @@ Configuration is done via class attributes and divided into three main categorie
 * `root_path` [String] **(inherited)**  
   The path from the `base_url` of the root URL.
 
+* `initial_paths` [Array] **(inherited)**  
+  A list of paths (from the `base_url`) to add to the initial queue. Useful for scraping isolated documents.  
+  Defaults to `[]`. _(Note: the `root_path` is added to the array at runtime.)_
+
 * `dir` [String] **(required, `FileScraper` only)**  
   The absolute path where the files are located on the local filesystem.  
   _Note: `FileScraper` works exactly like `UrlScraper` (manipulating the same kind of URLs) except that it substitutes `base_url` with `dir` in order to read files instead of making HTTP requests._

From e556beb61843a82ca0fe97b240c2e5c6f5c32743 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Thu, 12 Dec 2013 08:51:15 -0800
Subject: [PATCH 18/54] Updated Filter Reference (markdown)

---
 Filter-Reference.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Filter-Reference.md b/Filter-Reference.md
index 5e852b3f..c37ccf75 100644
--- a/Filter-Reference.md
+++ b/Filter-Reference.md
@@ -70,6 +70,9 @@ The `call` method must return either `doc` or `html`, depending on the type of f
 * `root_page?` [Boolean]  
   Returns `true` if the current page is the root page.
 
+* `initial_page?` [Boolean]  
+  Returns `true` if the current page is the root page or its subpath is one of the scraper's `initial_paths`.
+
 ## Core filters
 
 * [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside)

From bac284b0492f42b599850aa56c5c0bff6b11640e Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 12 Jan 2014 12:04:59 -0800
Subject: [PATCH 19/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index a50130f6..9cabecd1 100644
--- a/Home.md
+++ b/Home.md
@@ -8,4 +8,5 @@
 
 * [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
 * [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
-* [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
\ No newline at end of file
+* [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
+* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
\ No newline at end of file

From 6573650a50f2e46128a75c1ce28890ae08e35298 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 18 Jan 2014 13:09:35 -0800
Subject: [PATCH 20/54] Updated Home (markdown)

---
 Home.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Home.md b/Home.md
index 9cabecd1..89c81115 100644
--- a/Home.md
+++ b/Home.md
@@ -7,6 +7,7 @@
 ### Plugins and Extensions
 
 * [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
+* [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
 * [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
 * [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
 * [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
\ No newline at end of file

From 3cf2280cfbaabf14c4e59dad4d7aa3ddadc5487b Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Thu, 23 Jan 2014 15:14:09 -0800
Subject: [PATCH 21/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 89c81115..835b79b2 100644
--- a/Home.md
+++ b/Home.md
@@ -10,4 +10,5 @@
 * [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
 * [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs)
 * [Brackets extension](https://github.com/gruehle/dev-docs-viewer)
-* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
\ No newline at end of file
+* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
+* [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell)
\ No newline at end of file

From 16494bbaa3ba738684822d93453ed87db599554d Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 8 Mar 2014 15:01:14 -0800
Subject: [PATCH 22/54] Updated Home (markdown)

---
 Home.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Home.md b/Home.md
index 835b79b2..658eff41 100644
--- a/Home.md
+++ b/Home.md
@@ -9,6 +9,7 @@
 * [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
 * [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
 * [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)
\ No newline at end of file

From 79dca6eab4502ff818bef6107fc43fd5acd0fc42 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Thu, 3 Apr 2014 04:52:04 -0700
Subject: [PATCH 23/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 658eff41..fb3b9089 100644
--- a/Home.md
+++ b/Home.md
@@ -12,4 +12,5 @@
 * [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)
\ No newline at end of file
+* [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell)
+* [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
\ No newline at end of file

From b323e4371434a7dbade403e12750200f07d68bcf Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 5 Apr 2014 19:52:14 -0700
Subject: [PATCH 24/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index fb3b9089..ac0f2873 100644
--- a/Home.md
+++ b/Home.md
@@ -13,4 +13,5 @@
 * [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)
-* [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
\ No newline at end of file
+* [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
+* [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
\ No newline at end of file

From b4cf84184c8be0ea8b79f89ef0fbfebd74b4960b Mon Sep 17 00:00:00 2001
From: Romeo Van Snick <romeovs@gmail.com>
Date: Wed, 21 May 2014 06:04:18 -0700
Subject: [PATCH 25/54] it should say `docs:generate` instead of
 `docs:download` in step 6.

---
 Adding-documentations-to-DevDocs.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index 66eb5f24..dc08f4fa 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -12,7 +12,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
    * An [`Entries`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter) filter whose task is to determine the pages' metadata (the list of entries, each with a name, type and path).
    The [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference) page has all the details about filters.
 5. Using the `thor docs:page [my_doc] [path]` command, check that the scraper works properly. Files will appear in the `public/docs/[my_doc]/` directory (but not inside the app as the command doesn't touch the index).
-6. Generate the full documentation using the `thor docs:download [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
+6. Generate the full documentation using the `thor docs:generate [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
 7. Start the server, open the app, enable the documentation, and see how everything plays out.
 8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.
 9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in `application.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). _(Note: feel free to submit a pull request without custom CSS/JS)_

From 22e7dea45e3717c55b8cae7f8c172c464ad8ab39 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 11 Oct 2015 17:57:11 -0400
Subject: [PATCH 26/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index ac0f2873..1f0ba33c 100644
--- a/Home.md
+++ b/Home.md
@@ -14,4 +14,5 @@
 * [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app
 * [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell)
 * [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
-* [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
\ No newline at end of file
+* [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
+* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow)
\ No newline at end of file

From 3baf426c5c0223dec78a62ab0fd28ce435731537 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sun, 11 Oct 2015 17:58:27 -0400
Subject: [PATCH 27/54] Updated Home (markdown)

---
 Home.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Home.md b/Home.md
index 1f0ba33c..29cfb20b 100644
--- a/Home.md
+++ b/Home.md
@@ -10,9 +10,10 @@
 * [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
 * [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)
+* [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)
 * [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
 * [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
-* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow)
\ No newline at end of file
+* [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs) (1)
+* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow) (2)
\ No newline at end of file

From 03fc31118494fa6c4e22851c83c13edeea2800a3 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 30 Jan 2016 11:48:46 -0500
Subject: [PATCH 28/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 6a117395..f66bf6f3 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -54,7 +54,7 @@ Configuration is done via class attributes and divided into three main categorie
   Defines the CSS class name (`_[type]`) and custom JavaScript class (`app.views.[Type]Page`) that will be added/loaded on each page. Documentations sharing a similar structure (e.g. generated with the same tool or originating from the same website) should use the same `type` to avoid duplicating the CSS and JS.  
   Must include lowercase letters only.
 
-* `version` [String] **(required)**  
+* `release` [String] **(required)**  
   The version of the software at the time the scraper was last run. This is only informational and doesn't affect the scraper's behavior.
 
 * `base_url` [String] **(required in `UrlScraper`)**  

From 6650b84b5c47cafa2e9e8696b6881233d6c41037 Mon Sep 17 00:00:00 2001
From: Kirill Shevchenko <kirillweb@users.noreply.github.com>
Date: Tue, 2 Feb 2016 12:52:18 +0200
Subject: [PATCH 29/54] Updated Home (markdown)

---
 Home.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Home.md b/Home.md
index 29cfb20b..f9f0a858 100644
--- a/Home.md
+++ b/Home.md
@@ -3,6 +3,7 @@
 * [Adding documentations to DevDocs](https://github.com/Thibaut/devdocs/wiki/Adding-documentations-to-DevDocs)
 * [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference)
 * [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference)
+* [Cool Ruby Guy](https://github.com/kirillweb)
 
 ### Plugins and Extensions
 

From 6b40dcb171d5b1232ea2d1b2cdfe5fa8ae3e146f Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 2 Feb 2016 07:26:57 -0500
Subject: [PATCH 30/54] Revert 6650b84^...6650b84 on Home

---
 Home.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Home.md b/Home.md
index f9f0a858..29cfb20b 100644
--- a/Home.md
+++ b/Home.md
@@ -3,7 +3,6 @@
 * [Adding documentations to DevDocs](https://github.com/Thibaut/devdocs/wiki/Adding-documentations-to-DevDocs)
 * [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference)
 * [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference)
-* [Cool Ruby Guy](https://github.com/kirillweb)
 
 ### Plugins and Extensions
 

From c234c43f5a0120627c9f9280192ec418e3bec54e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Machist=C3=A9=20N=2E=20Quintana?=
 <mnquintana@users.noreply.github.com>
Date: Mon, 4 Apr 2016 22:03:51 -0700
Subject: [PATCH 31/54] Add note about what path means in thor docs:page
 command

---
 Adding-documentations-to-DevDocs.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index dc08f4fa..00e250f7 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -11,7 +11,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
    * A [`CleanHtml`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential.
    * An [`Entries`](https://github.com/Thibaut/devdocs/wiki/Filter-Reference#entriesfilter) filter whose task is to determine the pages' metadata (the list of entries, each with a name, type and path).
    The [Filter Reference](https://github.com/Thibaut/devdocs/wiki/Filter-Reference) page has all the details about filters.
-5. Using the `thor docs:page [my_doc] [path]` command, check that the scraper works properly. Files will appear in the `public/docs/[my_doc]/` directory (but not inside the app as the command doesn't touch the index).
+5. Using the `thor docs:page [my_doc] [path]` command, check that the scraper works properly. Files will appear in the `public/docs/[my_doc]/` directory (but not inside the app as the command doesn't touch the index). `path` in this case refers to either the remote path (if using `UrlScraper`) or the local path (if using `FileScraper`).
 6. Generate the full documentation using the `thor docs:generate [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
 7. Start the server, open the app, enable the documentation, and see how everything plays out.
 8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.

From 8d434052f601805693aa13e989bb332521d470ae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Busqu=C3=A9?= <marc@lamarciana.com>
Date: Thu, 2 Jun 2016 18:15:00 +0200
Subject: [PATCH 32/54] Add vim-www as vim plugin to be used to search devdocs

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 29cfb20b..58426cdf 100644
--- a/Home.md
+++ b/Home.md
@@ -16,4 +16,5 @@
 * [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
 * [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
 * [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs) (1)
-* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow) (2)
\ No newline at end of file
+* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow) (2)
+* [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', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>dd` mapping.
\ No newline at end of file

From dce0e15b58dc818d9b84deced4c6c9b9a47b1948 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Sat, 3 Dec 2016 11:31:40 -0500
Subject: [PATCH 33/54] Updated Home (markdown)

---
 Home.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Home.md b/Home.md
index 58426cdf..d3b7c840 100644
--- a/Home.md
+++ b/Home.md
@@ -8,6 +8,7 @@
 
 * [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
 * [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
+* [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) 

From aace7d60a82ae0e3d2fee4a7b4e0afa7da66b985 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 18 Jul 2017 08:12:33 -0400
Subject: [PATCH 34/54] Update plugin list

---
 Home.md | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Home.md b/Home.md
index d3b7c840..ebfe6f4e 100644
--- a/Home.md
+++ b/Home.md
@@ -7,15 +7,14 @@
 ### Plugins and Extensions
 
 * [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe)
-* [Firefox web app](https://marketplace.firefox.com/app/devdocs/)
 * [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)
-* [Chrome desktop app](https://github.com/arosemena/DevDocsWrapper)
 * [Emacs lookup](https://github.com/skeeto/devdocs-lookup)
-* [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs) (1)
-* [Alfred Workflow](https://github.com/jeffscottward/DevDocsIO-AlfredWorkflow) (2)
-* [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', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>dd` mapping.
\ No newline at end of file
+* [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', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>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)
\ No newline at end of file

From 9dd1a5140180106e368af38f47057b0a4f5ee2b5 Mon Sep 17 00:00:00 2001
From: Jed Fox <git@twopointzero.us>
Date: Tue, 31 Oct 2017 18:03:13 -0400
Subject: [PATCH 35/54] Add a footer to the wiki

---
 _Footer.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 _Footer.md

diff --git a/_Footer.md b/_Footer.md
new file mode 100644
index 00000000..739edc02
--- /dev/null
+++ b/_Footer.md
@@ -0,0 +1 @@
+Feel free to edit this page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs).
\ No newline at end of file

From c57e3e49a4c926fef3980f8c0da0dc734de0b51a Mon Sep 17 00:00:00 2001
From: Jed Fox <git@twopointzero.us>
Date: Tue, 31 Oct 2017 18:03:57 -0400
Subject: [PATCH 36/54] Move the message at the bottom to the footer

---
 Adding-documentations-to-DevDocs.md | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index 00e250f7..df2e5658 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -21,7 +21,4 @@ Adding a documentation may look like a daunting task but once you get the hang o
 
 If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
 
-Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
-
----
-_Feel free to edit this page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file
+Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
\ No newline at end of file

From 175ca4bea1fd9624f023cd34035fdadb78316b20 Mon Sep 17 00:00:00 2001
From: Jed Fox <git@twopointzero.us>
Date: Tue, 31 Oct 2017 18:04:22 -0400
Subject: [PATCH 37/54] Move the message at the bottom to the footer

---
 Filter-Reference.md | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Filter-Reference.md b/Filter-Reference.md
index c37ccf75..b96cff7d 100644
--- a/Filter-Reference.md
+++ b/Filter-Reference.md
@@ -221,6 +221,3 @@ module Docs
   end
 end
 ```
-
----
-_Feel free to edit this page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file

From 6d1b33a6c4e6b72956c0baa324e96e0f5df5ce05 Mon Sep 17 00:00:00 2001
From: Jed Fox <git@twopointzero.us>
Date: Tue, 31 Oct 2017 18:04:43 -0400
Subject: [PATCH 38/54] Move the message at the bottom to the footer

---
 Scraper-Reference.md | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index f66bf6f3..8392c264 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -186,6 +186,3 @@ More information about how filters work is available on the [Filter Reference](h
     Overrides the `:title` option for the root page only.
 
   _Note: this filter is disabled by default._
-
----
-_Feel free to edit wiki page or ask for improvements on the [mailing list](https://groups.google.com/d/forum/devdocs)._
\ No newline at end of file

From a54c8f178b1dab9904f1475389e0194674bab37b Mon Sep 17 00:00:00 2001
From: Matt Brookes <github@nospam.33m.co>
Date: Wed, 15 Nov 2017 14:20:14 +0000
Subject: [PATCH 39/54] /CamelCase/PascalCase/

---
 Adding-documentations-to-DevDocs.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index df2e5658..cd95cc15 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -4,7 +4,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
 
 **Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md) before submitting a new documentation.
 
-1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [CamelCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
+1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
 2. Add the appropriate class attributes and filter options (see the [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference) page).
 3. Check that the scraper is listed in `thor docs:list`.
 4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference#filter-stacks). You may create any number of filters but will need at least the following two:

From 56b75caa37d9cd9b3475249b8b19bc99be47b316 Mon Sep 17 00:00:00 2001
From: Simon Legner <Simon.Legner@gmail.com>
Date: Tue, 12 Dec 2017 22:07:25 +0100
Subject: [PATCH 40/54] linkfix (Nokogiri on rubydoc.info)

---
 Filter-Reference.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Filter-Reference.md b/Filter-Reference.md
index b96cff7d..46e0efd4 100644
--- a/Filter-Reference.md
+++ b/Filter-Reference.md
@@ -33,7 +33,7 @@ The `call` method must return either `doc` or `html`, depending on the type of f
 
 * `doc` [Nokogiri::XML::Node]  
   The Nokogiri representation of the container element.  
-  See [Nokogiri's API docs](http://nokogiri.org/Nokogiri/XML/Node.html#methods_nav) for the list of available methods.
+  See [Nokogiri's API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node) for the list of available methods.
 
 * `html` [String]  
   The string representation of the container element.
@@ -97,7 +97,7 @@ Scrapers can have any number of custom filters but require at least the two desc
 
 The `CleanHtml` filter is tasked with cleaning the HTML markup where necessary and removing anything superfluous or nonessential. Only the core documentation should remain at the end.
 
-Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](http://nokogiri.org/Nokogiri/XML/Node.html#methods_nav).
+Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node).
 
 Here's an example implementation that covers the most common use-cases:
 

From 68e12ca1846d99837bb974583d515529a7642447 Mon Sep 17 00:00:00 2001
From: sterbalr <robert.sterbal@aesynt.com>
Date: Mon, 7 May 2018 10:13:16 -0400
Subject: [PATCH 41/54] Updated Adding documentations to DevDocs (markdown =>
 mediawiki)

---
 ...o-DevDocs.md => Adding-documentations-to-DevDocs.mediawiki | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
 rename Adding-documentations-to-DevDocs.md => Adding-documentations-to-DevDocs.mediawiki (98%)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.mediawiki
similarity index 98%
rename from Adding-documentations-to-DevDocs.md
rename to Adding-documentations-to-DevDocs.mediawiki
index cd95cc15..935b80a7 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.mediawiki
@@ -21,4 +21,6 @@ Adding a documentation may look like a daunting task but once you get the hang o
 
 If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
 
-Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
\ No newline at end of file
+Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
+
+return [[Home]]
\ No newline at end of file

From 52e52090256a4b64d4a1a631c0ec6b2f5ffa3e9b Mon Sep 17 00:00:00 2001
From: sterbalr <robert.sterbal@aesynt.com>
Date: Mon, 7 May 2018 10:14:14 -0400
Subject: [PATCH 42/54] Updated Filter Reference (markdown => mediawiki)

---
 Filter-Reference.md => Filter-Reference.mediawiki | 3 +++
 1 file changed, 3 insertions(+)
 rename Filter-Reference.md => Filter-Reference.mediawiki (99%)

diff --git a/Filter-Reference.md b/Filter-Reference.mediawiki
similarity index 99%
rename from Filter-Reference.md
rename to Filter-Reference.mediawiki
index 46e0efd4..de82b2cb 100644
--- a/Filter-Reference.md
+++ b/Filter-Reference.mediawiki
@@ -221,3 +221,6 @@ module Docs
   end
 end
 ```
+
+
+return [[Home]]
\ No newline at end of file

From f357f0c9194a81b7c17e888867d98bbb519ac33c Mon Sep 17 00:00:00 2001
From: sterbalr <robert.sterbal@aesynt.com>
Date: Mon, 7 May 2018 10:19:53 -0400
Subject: [PATCH 43/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 8392c264..2ac4f809 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -186,3 +186,5 @@ More information about how filters work is available on the [Filter Reference](h
     Overrides the `:title` option for the root page only.
 
   _Note: this filter is disabled by default._
+
+return [[Home]]
\ No newline at end of file

From 9a7bbba2b2d74b918148ad42e51b91ab65fc9ef1 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 8 May 2018 13:22:06 -0400
Subject: [PATCH 44/54] Updated Filter Reference (mediawiki => markdown)

---
 Filter-Reference.mediawiki => Filter-Reference.md | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename Filter-Reference.mediawiki => Filter-Reference.md (100%)

diff --git a/Filter-Reference.mediawiki b/Filter-Reference.md
similarity index 100%
rename from Filter-Reference.mediawiki
rename to Filter-Reference.md

From 41e8d870545bc0339d140d05d8e90eb6e633890d Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 8 May 2018 13:22:30 -0400
Subject: [PATCH 45/54] Updated Scraper Reference (markdown)

---
 Scraper-Reference.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Scraper-Reference.md b/Scraper-Reference.md
index 2ac4f809..8392c264 100644
--- a/Scraper-Reference.md
+++ b/Scraper-Reference.md
@@ -186,5 +186,3 @@ More information about how filters work is available on the [Filter Reference](h
     Overrides the `:title` option for the root page only.
 
   _Note: this filter is disabled by default._
-
-return [[Home]]
\ No newline at end of file

From 6fa2c5677bac9440d973df52f5c4f6d8f37adc12 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 8 May 2018 13:22:56 -0400
Subject: [PATCH 46/54] Updated Adding documentations to DevDocs (mediawiki =>
 markdown)

---
 ...ns-to-DevDocs.mediawiki => Adding-documentations-to-DevDocs.md | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename Adding-documentations-to-DevDocs.mediawiki => Adding-documentations-to-DevDocs.md (100%)

diff --git a/Adding-documentations-to-DevDocs.mediawiki b/Adding-documentations-to-DevDocs.md
similarity index 100%
rename from Adding-documentations-to-DevDocs.mediawiki
rename to Adding-documentations-to-DevDocs.md

From 308c6253784504f0d4cf62551ed9dc245fbbee00 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 8 May 2018 13:23:07 -0400
Subject: [PATCH 47/54] Updated Adding documentations to DevDocs (markdown)

---
 Adding-documentations-to-DevDocs.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index 935b80a7..2ce50801 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -1,5 +1,3 @@
----
-
 Adding a documentation may look like a daunting task but once you get the hang of it, it's actually quite simple. Don't hesitate to ask for help on the [mailing list](https://groups.google.com/d/forum/devdocs) if you ever get stuck.
 
 **Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md) before submitting a new documentation.

From 1e5fd0be9e426fbdc7fd59f1d24f95a4bb2fbf41 Mon Sep 17 00:00:00 2001
From: Thibaut Courouble <thibaut@me.com>
Date: Tue, 8 May 2018 13:23:38 -0400
Subject: [PATCH 48/54] Updated Adding documentations to DevDocs (markdown)

---
 Adding-documentations-to-DevDocs.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index 2ce50801..f7c40e65 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -19,6 +19,4 @@ Adding a documentation may look like a daunting task but once you get the hang o
 
 If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
 
-Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
-
-return [[Home]]
\ No newline at end of file
+Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
\ No newline at end of file

From 6791d6956994c4125e44e9549eade21c8eeb27fa Mon Sep 17 00:00:00 2001
From: Beau Carnes <beaucarnes@gmail.com>
Date: Thu, 14 Jun 2018 14:49:18 -0400
Subject: [PATCH 49/54] Indicate that new scss files need to also be referenced
 in application-dark.css.scss

---
 Adding-documentations-to-DevDocs.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index f7c40e65..30ad13fa 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -13,7 +13,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
 6. Generate the full documentation using the `thor docs:generate [my_doc] --force` command. Additionally, you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what changed since the last run), and the `--debug` option to see which URLs are being requested and added to the queue (useful to pin down which page adds unwanted URLs to the queue).
 7. Start the server, open the app, enable the documentation, and see how everything plays out.
 8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.
-9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in `application.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). _(Note: feel free to submit a pull request without custom CSS/JS)_
+9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in both `application.css.scss` AND `application-dark.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). _(Note: feel free to submit a pull request without custom CSS/JS)_
 10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the `assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
 11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. It'll be added to the icon sprite after your pull request is merged.
 

From 8d3c370207f7049989436b906ee81d4a60b84925 Mon Sep 17 00:00:00 2001
From: Jasper van Merle <jaspervmerle@gmail.com>
Date: Sat, 6 Oct 2018 17:59:12 +0200
Subject: [PATCH 50/54] Updated Home (markdown)

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index ebfe6f4e..6a295699 100644
--- a/Home.md
+++ b/Home.md
@@ -17,4 +17,5 @@
 * [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', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>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)
\ No newline at end of file
+* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) (2)
+* [Desktop application](https://github.com/egoist/devdocs-desktop)
\ No newline at end of file

From 7cb5a8bd26e364f2dea2fa55a92ec89154684fbc Mon Sep 17 00:00:00 2001
From: Incomplete <incomplete@aixon.co>
Date: Sun, 7 Oct 2018 21:11:57 +0800
Subject: [PATCH 51/54] Add "Doc Browser" to the "Plugins and Extensions"
 section

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index 6a295699..fe330cb0 100644
--- a/Home.md
+++ b/Home.md
@@ -18,4 +18,5 @@
 * [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', '<leader>dd'] }` to have a `:Devdocs` command and a `<leader>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)
\ No newline at end of file
+* [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
\ No newline at end of file

From 0603fa19ef18f2feb6fa5eed2ffc7e0e51f1d457 Mon Sep 17 00:00:00 2001
From: Benjamin Lupton <b@lupton.cc>
Date: Wed, 7 Nov 2018 14:29:51 +1100
Subject: [PATCH 52/54] removed link to contributing guide, as it does not
 exist

---
 Adding-documentations-to-DevDocs.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index 30ad13fa..a02cb70c 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -1,7 +1,5 @@
 Adding a documentation may look like a daunting task but once you get the hang of it, it's actually quite simple. Don't hesitate to ask for help on the [mailing list](https://groups.google.com/d/forum/devdocs) if you ever get stuck.
 
-**Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md) before submitting a new documentation.
-
 1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
 2. Add the appropriate class attributes and filter options (see the [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference) page).
 3. Check that the scraper is listed in `thor docs:list`.

From 02cfbbab8bf4a81cc0017a07b23e5c4f8ecfcdc4 Mon Sep 17 00:00:00 2001
From: Jasper van Merle <jaspervmerle@gmail.com>
Date: Wed, 7 Nov 2018 08:11:01 +0100
Subject: [PATCH 53/54] Re-add link to contributing.md

---
 Adding-documentations-to-DevDocs.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Adding-documentations-to-DevDocs.md b/Adding-documentations-to-DevDocs.md
index a02cb70c..f86ad62c 100644
--- a/Adding-documentations-to-DevDocs.md
+++ b/Adding-documentations-to-DevDocs.md
@@ -1,5 +1,7 @@
 Adding a documentation may look like a daunting task but once you get the hang of it, it's actually quite simple. Don't hesitate to ask for help on the [mailing list](https://groups.google.com/d/forum/devdocs) if you ever get stuck.
 
+**Note:** please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/.github/CONTRIBUTING.md) before submitting a new documentation.
+
 1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
 2. Add the appropriate class attributes and filter options (see the [Scraper Reference](https://github.com/Thibaut/devdocs/wiki/Scraper-Reference) page).
 3. Check that the scraper is listed in `thor docs:list`.

From d089dc53892d84d987e9f7f06b7949a802298553 Mon Sep 17 00:00:00 2001
From: Jonian Guveli <jonian@hardpixel.eu>
Date: Mon, 19 Nov 2018 17:13:43 +0200
Subject: [PATCH 54/54] Add DevDocs Desktop GNOME application link

---
 Home.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Home.md b/Home.md
index fe330cb0..6fc3fe06 100644
--- a/Home.md
+++ b/Home.md
@@ -19,4 +19,5 @@
 * [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
\ No newline at end of file
+* [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
\ No newline at end of file