Unified · Split
| @@ -6,3 +6,6 @@ indent_style = space · 5 unmodified lines | ||
| 6 | 6 | indent_size = 2 |
| 7 | 7 | insert_final_newline = true |
| 8 | 8 | trim_trailing_whitespace = true |
| 9 | + | |
| 10 | +[*.md] | |
| 11 | +trim_trailing_whitespace = false | |
| @@ -24,20 +24,18 @@ Want to contribute? Great. Please review the following guidelines carefully and · 23 unmodified lines | ||
| 24 | 24 | ## Requesting new features |
| 25 | 25 | |
| 26 | 26 | 1. Search for similar feature requests; someone may have already requested it. |
| 27 | −2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision). | |
| 27 | +2. Make sure your feature fits DevDocs's [vision](../README.md#vision). | |
| 28 | 28 | 3. Provide a clear and detailed explanation of the feature and why it's important to add it. |
| 29 | 29 | |
| 30 | −For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs). | |
| 31 | − | |
| 32 | 30 | ## Requesting new documentations |
| 33 | 31 | |
| 34 | −Please don't open issues to request new documentations. | |
| 32 | +Please don't open issues to request new documentations. | |
| 35 | 33 | Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote. |
| 36 | 34 | |
| 37 | 35 | ## Contributing code and features |
| 38 | 36 | |
| 39 | 37 | 1. Search for existing issues; someone may already be working on a similar feature. |
| 40 | −2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature. | |
| 38 | +2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature. | |
| 41 | 39 | 3. Follow the [coding conventions](#coding-conventions). |
| 42 | 40 | 4. If you're modifying the Ruby code, include tests and ensure they pass. |
| 43 | 41 | 5. Try to keep your pull request small and simple. |
| @@ -46,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 2 unmodified lines | ||
| 46 | 44 | |
| 47 | 45 | ## Contributing new documentations |
| 48 | 46 | |
| 49 | −See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations. | |
| 47 | +See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/master/docs) to learn how to add new documentations. | |
| 50 | 48 | |
| 51 | 49 | **Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements. |
| 52 | 50 | |
| @@ -57,20 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea · 4 unmodified lines | ||
| 57 | 55 | * Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.). |
| 58 | 56 | * Names must be as short as possible and unique across the documentation. |
| 59 | 57 | * The number of types (categories) should ideally be less than 100. |
| 60 | −* Don't modify the icon sprite. I'll do it after your pull request is merged. | |
| 61 | 58 | |
| 62 | 59 | ## Updating existing documentations |
| 63 | 60 | |
| 64 | −Please don't submit a pull request updating the version number of a documentation, unless a change is required in the scraper and you've verified that it works. | |
| 65 | − | |
| 66 | −To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here). | |
| 67 | − | |
| 68 | −## Other contributions | |
| 69 | − | |
| 70 | −Besides new docs and features, here are other ways you can contribute: | |
| 61 | +Please don't submit a pull request updating only the version number and/or the attribution of a documentation. Do submit a pull request if a bigger change is required in the scraper and you've verified that it works. | |
| 71 | 62 | |
| 72 | −* **Improve our copy.** English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated. | |
| 73 | −* **Participate in the issue tracker.** Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs). | |
| 63 | +To ask that an existing documentation be updated, first check the latest [documentation versions report](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc). Only create an issue if the documentation has been wrongly marked as up-to-date. | |
| 74 | 64 | |
| 75 | 65 | ## Coding conventions |
| 76 | 66 | |
| @@ -80,4 +70,4 @@ Besides new docs and features, here are other ways you can contribute: · 3 unmodified lines | ||
| 80 | 70 | |
| 81 | 71 | ## Questions? |
| 82 | 72 | |
| 83 | −If you have any questions, please feel free to ask on the [mailing list](https://groups.google.com/d/forum/devdocs). | |
| 73 | +If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs). | |
| @@ -2,6 +2,6 @@ · 1 unmodified line | ||
| 2 | 2 | Please read the contributing guidelines before opening an issue: |
| 3 | 3 | https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md |
| 4 | 4 | |
| 5 | − To request a new documentation, or an update of an existing documentation, go here: | |
| 5 | + Go here to request a new documentation: | |
| 6 | 6 | https://trello.com/b/6BmTulfx/devdocs-documentation |
| 7 | 7 | --> |
| @@ -1,11 +1,9 @@ | ||
| 1 | 1 | .DS_Store |
| 2 | 2 | .bundle |
| 3 | −*.pxm | |
| 4 | −*.sketch | |
| 3 | +log | |
| 5 | 4 | tmp |
| 6 | 5 | public/assets |
| 7 | 6 | public/fonts |
| 8 | 7 | public/docs/**/* |
| 9 | −!public/docs/docs.json | |
| 10 | −!public/docs/**/index.json | |
| 11 | −/docs/ | |
| 8 | +docs/**/* | |
| 9 | +!docs/*.md | |
| @@ -1 +1 @@ | ||
| 1 | −2.5.1 | |
| 1 | +2.6.3 | |
| @@ -1,2 +1 @@ | ||
| 1 | −public/icons | |
| 2 | −test | |
| 1 | +test | |
| @@ -1,7 +1,26 @@ | ||
| 1 | 1 | language: ruby |
| 2 | 2 | |
| 3 | +addons: | |
| 4 | + apt: | |
| 5 | + packages: | |
| 6 | + - libcurl4-openssl-dev | |
| 7 | + | |
| 3 | 8 | cache: bundler |
| 4 | 9 | |
| 5 | −before_script: | |
| 10 | +before_install: | |
| 11 | + - "echo 'gem: --no-document' > ~/.gemrc" | |
| 6 | 12 | - gem update --system |
| 7 | 13 | - gem install bundler |
| 14 | + | |
| 15 | +script: | |
| 16 | + - if [ "$TRAVIS_EVENT_TYPE" != "cron" ]; then bundle exec rake; fi | |
| 17 | + - if [ "$TRAVIS_EVENT_TYPE" = "cron" ]; then bundle exec thor updates:check --github-token $GH_TOKEN --upload; fi | |
| 18 | + | |
| 19 | +deploy: | |
| 20 | + provider: heroku | |
| 21 | + app: devdocs | |
| 22 | + on: | |
| 23 | + branch: master | |
| 24 | + condition: $TRAVIS_EVENT_TYPE != cron | |
| 25 | + api_key: | |
| 26 | + secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI=" | |
| @@ -0,0 +1,2 @@ | ||
| 1 | + | |
| 2 | +> Our Code of Conduct is available here: <https://code-of-conduct.freecodecamp.org/> | |
| @@ -1,13 +1,13 @@ | ||
| 1 | −Copyright 2013-2018 Thibaut Courouble and other contributors | |
| 1 | +Copyright 2013-2019 Thibaut Courouble and other contributors | |
| 2 | 2 | |
| 3 | 3 | This Source Code Form is subject to the terms of the Mozilla Public |
| 4 | 4 | License, v. 2.0. If a copy of the MPL was not distributed with this |
| 5 | 5 | file, You can obtain one at http://mozilla.org/MPL/2.0/. |
| 6 | 6 | |
| 7 | 7 | Please do not use the name DevDocs to endorse or promote products |
| 8 | −derived from this software without my permission, except as may be | |
| 9 | −necessary to comply with the notice/attribution requirements. | |
| 8 | +derived from this software without the maintainers' permission, except | |
| 9 | +as may be necessary to comply with the notice/attribution requirements. | |
| 10 | 10 | |
| 11 | −I also wish that any documentation file generated using this software | |
| 11 | +We also wish that any documentation file generated using this software | |
| 12 | 12 | be attributed to DevDocs. Let's be fair to all contributors by giving |
| 13 | 13 | credit where credit's due. Thanks. |
| @@ -1,11 +1,12 @@ | ||
| 1 | −FROM ruby:2.5.1 | |
| 1 | +FROM ruby:2.6.3 | |
| 2 | 2 | |
| 3 | 3 | ENV LANG=C.UTF-8 |
| 4 | +ENV ENABLE_SERVICE_WORKER=true | |
| 4 | 5 | |
| 5 | 6 | WORKDIR /devdocs |
| 6 | 7 | |
| 7 | 8 | RUN apt-get update && \ |
| 8 | − apt-get -y install git nodejs && \ | |
| 9 | + apt-get -y install git nodejs libcurl4 && \ | |
| 9 | 10 | gem install bundler && \ |
| 10 | 11 | rm -rf /var/lib/apt/lists/* |
| 11 | 12 | |
| @@ -1,12 +1,13 @@ | ||
| 1 | −FROM ruby:2.5.1-alpine | |
| 1 | +FROM ruby:2.6.3-alpine | |
| 2 | 2 | |
| 3 | 3 | ENV LANG=C.UTF-8 |
| 4 | +ENV ENABLE_SERVICE_WORKER=true | |
| 4 | 5 | |
| 5 | 6 | WORKDIR /devdocs |
| 6 | 7 | |
| 7 | 8 | COPY . /devdocs |
| 8 | 9 | |
| 9 | −RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev && \ | |
| 10 | +RUN apk --update add nodejs build-base libstdc++ gzip git zlib-dev libcurl && \ | |
| 10 | 11 | gem install bundler && \ |
| 11 | 12 | bundle install --system --without test && \ |
| 12 | 13 | thor docs:download --all && \ |
| @@ -1,9 +1,9 @@ | ||
| 1 | 1 | source 'https://rubygems.org' |
| 2 | −ruby '2.5.1' | |
| 2 | +ruby '2.6.3' | |
| 3 | 3 | |
| 4 | 4 | gem 'rake' |
| 5 | 5 | gem 'thor' |
| 6 | −gem 'pry', '~> 0.11.0' | |
| 6 | +gem 'pry', '~> 0.12.0' | |
| 7 | 7 | gem 'activesupport', '~> 5.2', require: false |
| 8 | 8 | gem 'yajl-ruby', require: false |
| 9 | 9 | gem 'html-pipeline' |
| @@ -22,6 +22,8 @@ group :app do · 12 unmodified lines | ||
| 22 | 22 | gem 'browser' |
| 23 | 23 | gem 'sass' |
| 24 | 24 | gem 'coffee-script' |
| 25 | + gem 'chunky_png' | |
| 26 | + gem 'sprockets-sass' | |
| 25 | 27 | end |
| 26 | 28 | |
| 27 | 29 | group :production do |
| @@ -40,6 +42,7 @@ group :docs do · 12 unmodified lines | ||
| 40 | 42 | gem 'unix_utils', require: false |
| 41 | 43 | gem 'tty-pager', require: false |
| 42 | 44 | gem 'net-sftp', '>= 2.1.3.rc2', require: false |
| 45 | + gem 'terminal-table', require: false | |
| 43 | 46 | end |
| 44 | 47 | |
| 45 | 48 | group :test do |
| @@ -1,127 +1,131 @@ | ||
| 1 | 1 | GEM |
| 2 | 2 | remote: https://rubygems.org/ |
| 3 | 3 | specs: |
| 4 | − activesupport (5.2.1) | |
| 4 | + activesupport (5.2.3) | |
| 5 | 5 | concurrent-ruby (~> 1.0, >= 1.0.2) |
| 6 | 6 | i18n (>= 0.7, < 2) |
| 7 | 7 | minitest (~> 5.1) |
| 8 | 8 | tzinfo (~> 1.1) |
| 9 | − backports (3.11.4) | |
| 10 | − better_errors (2.5.0) | |
| 9 | + backports (3.15.0) | |
| 10 | + better_errors (2.5.1) | |
| 11 | 11 | coderay (>= 1.0.0) |
| 12 | 12 | erubi (>= 1.0.0) |
| 13 | 13 | rack (>= 0.9.0) |
| 14 | − browser (2.5.3) | |
| 14 | + browser (2.6.1) | |
| 15 | + chunky_png (1.3.11) | |
| 15 | 16 | coderay (1.1.2) |
| 16 | 17 | coffee-script (2.4.1) |
| 17 | 18 | coffee-script-source |
| 18 | 19 | execjs |
| 19 | 20 | coffee-script-source (1.12.2) |
| 20 | − concurrent-ruby (1.1.3) | |
| 21 | − daemons (1.2.6) | |
| 22 | − erubi (1.7.1) | |
| 23 | − ethon (0.11.0) | |
| 21 | + concurrent-ruby (1.1.5) | |
| 22 | + daemons (1.3.1) | |
| 23 | + erubi (1.8.0) | |
| 24 | + ethon (0.12.0) | |
| 24 | 25 | ffi (>= 1.3.0) |
| 25 | 26 | eventmachine (1.2.7) |
| 26 | 27 | execjs (2.7.0) |
| 27 | − exifr (1.3.5) | |
| 28 | − ffi (1.9.25) | |
| 29 | − fspath (3.1.0) | |
| 30 | − highline (2.0.0) | |
| 31 | − html-pipeline (2.9.1) | |
| 28 | + exifr (1.3.6) | |
| 29 | + ffi (1.11.1) | |
| 30 | + fspath (3.1.2) | |
| 31 | + highline (2.0.2) | |
| 32 | + html-pipeline (2.11.1) | |
| 32 | 33 | activesupport (>= 2) |
| 33 | 34 | nokogiri (>= 1.4) |
| 34 | − i18n (1.1.1) | |
| 35 | + i18n (1.6.0) | |
| 35 | 36 | concurrent-ruby (~> 1.0) |
| 36 | − image_optim (0.26.3) | |
| 37 | + image_optim (0.26.5) | |
| 37 | 38 | exifr (~> 1.2, >= 1.2.2) |
| 38 | 39 | fspath (~> 3.0) |
| 39 | 40 | image_size (>= 1.5, < 3) |
| 40 | 41 | in_threads (~> 1.3) |
| 41 | 42 | progress (~> 3.0, >= 3.0.1) |
| 42 | − image_optim_pack (0.5.1) | |
| 43 | + image_optim_pack (0.5.6) | |
| 43 | 44 | fspath (>= 2.1, < 4) |
| 44 | 45 | image_optim (~> 0.19) |
| 45 | − image_size (2.0.0) | |
| 46 | − in_threads (1.5.0) | |
| 46 | + image_size (2.0.2) | |
| 47 | + in_threads (1.5.3) | |
| 47 | 48 | method_source (0.9.2) |
| 48 | − mini_portile2 (2.3.0) | |
| 49 | + mini_portile2 (2.4.0) | |
| 49 | 50 | minitest (5.11.3) |
| 50 | 51 | multi_json (1.13.1) |
| 51 | 52 | mustermann (1.0.3) |
| 52 | − net-sftp (2.1.3.rc2) | |
| 53 | − net-ssh (>= 2.6.5, < 5.0.0) | |
| 54 | − net-ssh (4.2.0) | |
| 55 | − newrelic_rpm (5.5.0.348) | |
| 56 | − nokogiri (1.8.5) | |
| 57 | − mini_portile2 (~> 2.3.0) | |
| 53 | + net-sftp (3.0.0.beta1) | |
| 54 | + net-ssh (>= 5.0.0, < 6.0.0) | |
| 55 | + net-ssh (5.2.0) | |
| 56 | + newrelic_rpm (6.5.0.357) | |
| 57 | + nokogiri (1.10.3) | |
| 58 | + mini_portile2 (~> 2.4.0) | |
| 58 | 59 | options (2.3.2) |
| 59 | − progress (3.5.0) | |
| 60 | + progress (3.5.2) | |
| 60 | 61 | progress_bar (1.3.0) |
| 61 | 62 | highline (>= 1.6, < 3) |
| 62 | 63 | options (~> 2.3.0) |
| 63 | − pry (0.11.3) | |
| 64 | + pry (0.12.2) | |
| 64 | 65 | coderay (~> 1.1.0) |
| 65 | 66 | method_source (~> 0.9.0) |
| 66 | − rack (2.0.6) | |
| 67 | − rack-protection (2.0.4) | |
| 67 | + rack (2.0.7) | |
| 68 | + rack-protection (2.0.5) | |
| 68 | 69 | rack |
| 69 | 70 | rack-ssl-enforcer (0.2.9) |
| 70 | 71 | rack-test (1.1.0) |
| 71 | 72 | rack (>= 1.0, < 3) |
| 72 | − rake (12.3.1) | |
| 73 | + rake (12.3.2) | |
| 73 | 74 | rb-fsevent (0.10.3) |
| 74 | − rb-inotify (0.9.10) | |
| 75 | − ffi (>= 0.5.0, < 2) | |
| 75 | + rb-inotify (0.10.0) | |
| 76 | + ffi (~> 1.0) | |
| 76 | 77 | rr (1.2.1) |
| 77 | − sass (3.7.2) | |
| 78 | + sass (3.7.4) | |
| 78 | 79 | sass-listen (~> 4.0.0) |
| 79 | 80 | sass-listen (4.0.0) |
| 80 | 81 | rb-fsevent (~> 0.9, >= 0.9.4) |
| 81 | 82 | rb-inotify (~> 0.9, >= 0.9.7) |
| 82 | − sinatra (2.0.4) | |
| 83 | + sinatra (2.0.5) | |
| 83 | 84 | mustermann (~> 1.0) |
| 84 | 85 | rack (~> 2.0) |
| 85 | − rack-protection (= 2.0.4) | |
| 86 | + rack-protection (= 2.0.5) | |
| 86 | 87 | tilt (~> 2.0) |
| 87 | − sinatra-contrib (2.0.4) | |
| 88 | − activesupport (>= 4.0.0) | |
| 88 | + sinatra-contrib (2.0.5) | |
| 89 | 89 | backports (>= 2.8.2) |
| 90 | 90 | multi_json |
| 91 | 91 | mustermann (~> 1.0) |
| 92 | − rack-protection (= 2.0.4) | |
| 93 | − sinatra (= 2.0.4) | |
| 92 | + rack-protection (= 2.0.5) | |
| 93 | + sinatra (= 2.0.5) | |
| 94 | 94 | tilt (>= 1.3, < 3) |
| 95 | 95 | sprockets (3.7.2) |
| 96 | 96 | concurrent-ruby (~> 1.0) |
| 97 | 97 | rack (> 1, < 3) |
| 98 | 98 | sprockets-helpers (1.2.1) |
| 99 | 99 | sprockets (>= 2.2) |
| 100 | − strings (0.1.4) | |
| 101 | − strings-ansi (~> 0.1.0) | |
| 102 | − unicode-display_width (~> 1.4.0) | |
| 103 | − unicode_utils (~> 1.4.0) | |
| 100 | + sprockets-sass (2.0.0.beta2) | |
| 101 | + sprockets (>= 2.0, < 4.0) | |
| 102 | + strings (0.1.5) | |
| 103 | + strings-ansi (~> 0.1) | |
| 104 | + unicode-display_width (~> 1.5) | |
| 105 | + unicode_utils (~> 1.4) | |
| 104 | 106 | strings-ansi (0.1.0) |
| 107 | + terminal-table (1.8.0) | |
| 108 | + unicode-display_width (~> 1.1, >= 1.1.1) | |
| 105 | 109 | thin (1.7.2) |
| 106 | 110 | daemons (~> 1.0, >= 1.0.9) |
| 107 | 111 | eventmachine (~> 1.0, >= 1.0.4) |
| 108 | 112 | rack (>= 1, < 3) |
| 109 | 113 | thor (0.20.3) |
| 110 | 114 | thread_safe (0.3.6) |
| 111 | − tilt (2.0.8) | |
| 112 | − tty-pager (0.11.0) | |
| 113 | − strings (~> 0.1.0) | |
| 114 | − tty-screen (~> 0.6.4) | |
| 115 | − tty-which (~> 0.3.0) | |
| 116 | − tty-screen (0.6.5) | |
| 117 | − tty-which (0.3.0) | |
| 115 | + tilt (2.0.9) | |
| 116 | + tty-pager (0.12.1) | |
| 117 | + strings (~> 0.1.4) | |
| 118 | + tty-screen (~> 0.6) | |
| 119 | + tty-which (~> 0.4) | |
| 120 | + tty-screen (0.7.0) | |
| 121 | + tty-which (0.4.1) | |
| 118 | 122 | typhoeus (1.3.1) |
| 119 | 123 | ethon (>= 0.9.0) |
| 120 | 124 | tzinfo (1.2.5) |
| 121 | 125 | thread_safe (~> 0.1) |
| 122 | 126 | uglifier (4.1.20) |
| 123 | 127 | execjs (>= 0.3.0, < 3) |
| 124 | − unicode-display_width (1.4.0) | |
| 128 | + unicode-display_width (1.6.0) | |
| 125 | 129 | unicode_utils (1.4.0) |
| 126 | 130 | unix_utils (0.0.15) |
| 127 | 131 | yajl-ruby (1.4.1) |
| @@ -133,6 +137,7 @@ DEPENDENCIES · 5 unmodified lines | ||
| 133 | 137 | activesupport (~> 5.2) |
| 134 | 138 | better_errors |
| 135 | 139 | browser |
| 140 | + chunky_png | |
| 136 | 141 | coffee-script |
| 137 | 142 | erubi |
| 138 | 143 | html-pipeline |
| @@ -143,7 +148,7 @@ DEPENDENCIES · 4 unmodified lines | ||
| 143 | 148 | newrelic_rpm |
| 144 | 149 | nokogiri |
| 145 | 150 | progress_bar |
| 146 | − pry (~> 0.11.0) | |
| 151 | + pry (~> 0.12.0) | |
| 147 | 152 | rack |
| 148 | 153 | rack-ssl-enforcer |
| 149 | 154 | rack-test |
| @@ -154,6 +159,8 @@ DEPENDENCIES · 4 unmodified lines | ||
| 154 | 159 | sinatra-contrib |
| 155 | 160 | sprockets |
| 156 | 161 | sprockets-helpers |
| 162 | + sprockets-sass | |
| 163 | + terminal-table | |
| 157 | 164 | thin |
| 158 | 165 | thor |
| 159 | 166 | tty-pager |
| @@ -163,7 +170,7 @@ DEPENDENCIES · 3 unmodified lines | ||
| 163 | 170 | yajl-ruby |
| 164 | 171 | |
| 165 | 172 | RUBY VERSION |
| 166 | − ruby 2.5.1p57 | |
| 173 | + ruby 2.6.3p62 | |
| 167 | 174 | |
| 168 | 175 | BUNDLED WITH |
| 169 | − 1.16.1 | |
| 176 | + 2.0.2 | |
| @@ -0,0 +1,11 @@ | ||
| 1 | +If you’re adding a new scraper, please ensure that you have: | |
| 2 | + | |
| 3 | +- [ ] Tested the scraper on a local copy of DevDocs | |
| 4 | +- [ ] Ensured that the docs are styled similarly to other docs on DevDocs | |
| 5 | +<!-- If the docs don’t have an icon, delete the next four items: --> | |
| 6 | +- [ ] Added these files to the <code>public/icons/*your_scraper_name*/</code> directory: | |
| 7 | + - [ ] `16.png`: a 16×16 pixel icon for the doc | |
| 8 | + - [ ] `16@2x.png`: a 32×32 pixel icon for the doc | |
| 9 | + - [ ] `SOURCE`: A text file containing the URL to the page the image can be found on or the URL of the original image itself | |
| 10 | + | |
| 11 | +<!-- Replace the `[ ]` with a `[x]` once you’ve completed each step. --> | |
| @@ -1,25 +1,24 @@ | ||
| 1 | −# [DevDocs](https://devdocs.io) [](https://travis-ci.org/freeCodeCamp/devdocs) | |
| 1 | +# [DevDocs](https://devdocs.io) — API Documentation Browser [](https://travis-ci.org/freeCodeCamp/devdocs) | |
| 2 | 2 | |
| 3 | −DevDocs combines multiple API documentations in a fast, organized, and searchable interface. | |
| 3 | +DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 4 | 4 | |
| 5 | −* Created by [Thibaut Courouble](https://thibaut.me) | |
| 5 | +DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org). | |
| 6 | 6 | |
| 7 | 7 | Keep track of development news: |
| 8 | 8 | |
| 9 | 9 | * Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs) |
| 10 | 10 | * Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription) |
| 11 | 11 | * Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter |
| 12 | −* Join the [mailing list](https://groups.google.com/d/forum/devdocs) | |
| 13 | 12 | |
| 14 | −**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions) | |
| 13 | +**Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [Documentation](#documentation) · [Plugins and Extensions](#plugins-and-extensions) · [License](#copyright--license) · [Questions?](#questions) | |
| 15 | 14 | |
| 16 | 15 | ## Quick Start |
| 17 | 16 | |
| 18 | −Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box. | |
| 17 | +Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box. | |
| 19 | 18 | |
| 20 | 19 | DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app. |
| 21 | 20 | |
| 22 | −DevDocs requires Ruby 2.5.1, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands: | |
| 21 | +DevDocs requires Ruby 2.6.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands: | |
| 23 | 22 | |
| 24 | 23 | ``` |
| 25 | 24 | git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs |
| @@ -60,14 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff · 34 unmodified lines | ||
| 60 | 59 | |
| 61 | 60 | Many of the code's design decisions were driven by the fact that the app uses XHR to load content directly into the main frame. This includes stripping the original documents of most of their HTML markup (e.g. scripts and stylesheets) to avoid polluting the main frame, and prefixing all CSS class names with an underscore to prevent conflicts. |
| 62 | 61 | |
| 63 | −Another driving factor is performance and the fact that everything happens in the browser. `applicationCache` (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings. | |
| 62 | +Another driving factor is performance and the fact that everything happens in the browser. A service worker (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings. | |
| 64 | 63 | |
| 65 | 64 | DevDocs being a developer tool, the browser requirements are high: |
| 66 | 65 | |
| 67 | 66 | * Recent versions of Firefox, Chrome, or Opera |
| 68 | −* Safari 9.1+ | |
| 69 | −* Edge 16+ | |
| 70 | −* iOS 10+ | |
| 67 | +* Safari 11.1+ | |
| 68 | +* Edge 17+ | |
| 69 | +* iOS 11.3+ | |
| 71 | 70 | |
| 72 | 71 | This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun! |
| 73 | 72 | |
| @@ -84,12 +83,13 @@ Modifications made to each document include: · 10 unmodified lines | ||
| 84 | 83 | * replacing all external (not scraped) URLs with their fully qualified counterpart |
| 85 | 84 | * replacing all internal (scraped) URLs with their unqualified and relative counterpart |
| 86 | 85 | * adding content, such as a title and link to the original document |
| 86 | +* ensuring correct syntax highlighting using [Prism](http://prismjs.com/) | |
| 87 | 87 | |
| 88 | 88 | These modifications are applied via a set of filters using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. Each scraper includes filters specific to itself, one of which is tasked with figuring out the pages' metadata. |
| 89 | 89 | |
| 90 | 90 | The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.). |
| 91 | 91 | |
| 92 | −More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki). | |
| 92 | +More information about [scrapers](./docs/scraper-reference.md) and [filters](./docs/filter-reference.md) is available in the `docs` folder. | |
| 93 | 93 | |
| 94 | 94 | ## Available Commands |
| 95 | 95 | |
| @@ -129,20 +129,45 @@ If multiple versions of Ruby are installed on your system, commands must be run · 33 unmodified lines | ||
| 129 | 129 | |
| 130 | 130 | ## Contributing |
| 131 | 131 | |
| 132 | −Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md). | |
| 133 | − | |
| 134 | −DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki). | |
| 132 | +Contributions are welcome. Please read the [contributing guidelines](./.github/CONTRIBUTING.md). | |
| 133 | + | |
| 134 | +## Documentation | |
| 135 | + | |
| 136 | +* [Adding documentations to DevDocs](./docs/adding-docs.md) | |
| 137 | +* [Scraper Reference](./docs/scraper-reference.md) | |
| 138 | +* [Filter Reference](./docs/filter-reference.md) | |
| 139 | +* [Maintainers’ Guide](./docs/maintainers.md) | |
| 140 | + | |
| 141 | +## Plugins and Extensions | |
| 142 | + | |
| 143 | +* [Chrome web app](https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe) | |
| 144 | +* [Ubuntu Touch app](https://uappexplorer.com/app/devdocsunofficial.berkes) | |
| 145 | +* [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs) | |
| 146 | +* [Atom plugin](https://atom.io/packages/devdocs) | |
| 147 | +* [Brackets extension](https://github.com/gruehle/dev-docs-viewer) | |
| 148 | +* [Fluid](http://fluidapp.com) for turning DevDocs into a real OS X app | |
| 149 | +* [GTK shell / Vim integration](https://github.com/naquad/devdocs-shell) | |
| 150 | +* [Emacs lookup](https://github.com/skeeto/devdocs-lookup) | |
| 151 | +* [Alfred Workflow](https://github.com/yannickglt/alfred-devdocs) | |
| 152 | +* [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. | |
| 153 | +* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=akfish.vscode-devdocs ) (1) | |
| 154 | +* [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) (2) | |
| 155 | +* [Desktop application](https://github.com/egoist/devdocs-desktop) | |
| 156 | +* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets | |
| 157 | +* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar | |
| 158 | +* [macOS Application](https://github.com/dteoh/devdocs-macos) | |
| 159 | +* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView | |
| 135 | 160 | |
| 136 | 161 | ## Copyright / License |
| 137 | 162 | |
| 138 | −Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) | |
| 163 | +Copyright 2013-2019 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) | |
| 139 | 164 | |
| 140 | −This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files. | |
| 165 | +This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](./COPYRIGHT) and [LICENSE](./LICENSE) files. | |
| 141 | 166 | |
| 142 | −Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements. | |
| 167 | +Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements. | |
| 143 | 168 | |
| 144 | −I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks! | |
| 169 | +We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks! | |
| 145 | 170 | |
| 146 | 171 | ## Questions? |
| 147 | 172 | |
| 148 | −If you have any questions, please feel free to ask them on the [mailing list](https://groups.google.com/d/forum/devdocs). | |
| 173 | +If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs). | |
| @@ -0,0 +1 @@ | ||
| 1 | +sprites/**/* | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -13,10 +13,12 @@ · 12 unmodified lines | ||
| 13 | 13 | |
| 14 | 14 | @el = $('._app') |
| 15 | 15 | @localStorage = new LocalStorageStore |
| 16 | − @appCache = new app.AppCache if app.AppCache.isEnabled() | |
| 16 | + @serviceWorker = new app.ServiceWorker if app.ServiceWorker.isEnabled() | |
| 17 | 17 | @settings = new app.Settings |
| 18 | 18 | @db = new app.DB() |
| 19 | 19 | |
| 20 | + @settings.initLayout() | |
| 21 | + | |
| 20 | 22 | @docs = new app.collections.Docs |
| 21 | 23 | @disabledDocs = new app.collections.Docs |
| 22 | 24 | @entries = new app.collections.Entries |
| @@ -76,7 +78,7 @@ · 53 unmodified lines | ||
| 76 | 78 | .install() |
| 77 | 79 | @previousErrorHandler = onerror |
| 78 | 80 | window.onerror = @onWindowError.bind(@) |
| 79 | − CookieStore.onBlocked = @onCookieBlocked | |
| 81 | + CookiesStore.onBlocked = @onCookieBlocked | |
| 80 | 82 | return |
| 81 | 83 | |
| 82 | 84 | bootOne: -> |
| @@ -138,7 +140,10 @@ · 55 unmodified lines | ||
| 138 | 140 | @docs.sort() |
| 139 | 141 | @initDoc(doc) |
| 140 | 142 | @saveDocs() |
| 141 | − _onSuccess() | |
| 143 | + if app.settings.get('autoInstall') | |
| 144 | + doc.install(_onSuccess, onError) | |
| 145 | + else | |
| 146 | + _onSuccess() | |
| 142 | 147 | return |
| 143 | 148 | |
| 144 | 149 | doc.load onSuccess, onError, writeCache: true |
| @@ -147,7 +152,7 @@ · 2 unmodified lines | ||
| 147 | 152 | saveDocs: -> |
| 148 | 153 | @settings.setDocs(doc.slug for doc in @docs.all()) |
| 149 | 154 | @db.migrate() |
| 150 | − @appCache?.updateInBackground() | |
| 155 | + @serviceWorker?.updateInBackground() | |
| 151 | 156 | |
| 152 | 157 | welcomeBack: -> |
| 153 | 158 | visitCount = @settings.get('count') |
| @@ -167,14 +172,14 @@ · 13 unmodified lines | ||
| 167 | 172 | reload: -> |
| 168 | 173 | @docs.clearCache() |
| 169 | 174 | @disabledDocs.clearCache() |
| 170 | − if @appCache then @appCache.reload() else @reboot() | |
| 175 | + if @serviceWorker then @serviceWorker.reload() else @reboot() | |
| 171 | 176 | return |
| 172 | 177 | |
| 173 | 178 | reset: -> |
| 174 | 179 | @localStorage.reset() |
| 175 | 180 | @settings.reset() |
| 176 | 181 | @db?.reset() |
| 177 | − @appCache?.update() | |
| 182 | + @serviceWorker?.update() | |
| 178 | 183 | window.location = '/' |
| 179 | 184 | return |
| 180 | 185 | |
| @@ -193,9 +198,9 @@ · 12 unmodified lines | ||
| 193 | 198 | return |
| 194 | 199 | |
| 195 | 200 | indexHost: -> |
| 196 | − # Can't load the index files from the host/CDN when applicationCache is | |
| 201 | + # Can't load the index files from the host/CDN when service worker is | |
| 197 | 202 | # enabled because it doesn't support caching URLs that use CORS. |
| 198 | − @config[if @appCache and @settings.hasDocs() then 'index_path' else 'docs_origin'] | |
| 203 | + @config[if @serviceWorker and @settings.hasDocs() then 'index_path' else 'docs_origin'] | |
| 199 | 204 | |
| 200 | 205 | onBootError: (args...) -> |
| 201 | 206 | @trigger 'bootError' |
| @@ -252,7 +257,7 @@ · 50 unmodified lines | ||
| 252 | 257 | matchMedia: !!window.matchMedia |
| 253 | 258 | insertAdjacentHTML: !!document.body.insertAdjacentHTML |
| 254 | 259 | defaultPrevented: document.createEvent('CustomEvent').defaultPrevented is false |
| 255 | − cssVariables: CSS.supports and CSS.supports('(--t: 0)') | |
| 260 | + cssVariables: !!CSS?.supports?('(--t: 0)') | |
| 256 | 261 | |
| 257 | 262 | for key, value of features when not value |
| 258 | 263 | Raven.captureMessage "unsupported/#{key}", level: 'info' |
| @@ -1,42 +0,0 @@ | ||
| 1 | −class app.AppCache | |
| 2 | − $.extend @prototype, Events | |
| 3 | − | |
| 4 | − @isEnabled: -> | |
| 5 | − try | |
| 6 | − applicationCache and applicationCache.status isnt applicationCache.UNCACHED | |
| 7 | − catch | |
| 8 | − | |
| 9 | − constructor: -> | |
| 10 | − @cache = applicationCache | |
| 11 | − @notifyUpdate = true | |
| 12 | − @onUpdateReady() if @cache.status is @cache.UPDATEREADY | |
| 13 | − | |
| 14 | − $.on @cache, 'progress', @onProgress | |
| 15 | − $.on @cache, 'updateready', @onUpdateReady | |
| 16 | − | |
| 17 | − update: -> | |
| 18 | − @notifyUpdate = true | |
| 19 | − @notifyProgress = true | |
| 20 | − try @cache.update() catch | |
| 21 | − return | |
| 22 | − | |
| 23 | − updateInBackground: -> | |
| 24 | − @notifyUpdate = false | |
| 25 | − @notifyProgress = false | |
| 26 | − try @cache.update() catch | |
| 27 | − return | |
| 28 | − | |
| 29 | − reload: -> | |
| 30 | − $.on @cache, 'updateready noupdate error', -> app.reboot() | |
| 31 | − @notifyUpdate = false | |
| 32 | − @notifyProgress = true | |
| 33 | − try @cache.update() catch | |
| 34 | − return | |
| 35 | − | |
| 36 | − onProgress: (event) => | |
| 37 | − @trigger 'progress', event if @notifyProgress | |
| 38 | − return | |
| 39 | − | |
| 40 | − onUpdateReady: => | |
| 41 | − @trigger 'updateready' if @notifyUpdate | |
| 42 | − return | |
| @@ -13,3 +13,6 @@ app.config = · 12 unmodified lines | ||
| 13 | 13 | version: <%= Time.now.to_i %> |
| 14 | 14 | release: <%= Time.now.utc.httpdate.to_json %> |
| 15 | 15 | mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css' |
| 16 | + favicon_spritesheet: '<%= image_path('sprites/docs.png') %>' | |
| 17 | + service_worker_path: '/service-worker.js' | |
| 18 | + service_worker_enabled: <%= App.environment == :production || ENV['ENABLE_SERVICE_WORKER'] == 'true' %> | |
| @@ -0,0 +1,49 @@ | ||
| 1 | +class app.ServiceWorker | |
| 2 | + $.extend @prototype, Events | |
| 3 | + | |
| 4 | + @isEnabled: -> | |
| 5 | + !!navigator.serviceWorker and app.config.service_worker_enabled | |
| 6 | + | |
| 7 | + constructor: -> | |
| 8 | + @registration = null | |
| 9 | + @notifyUpdate = true | |
| 10 | + | |
| 11 | + navigator.serviceWorker.register(app.config.service_worker_path, {scope: '/'}) | |
| 12 | + .then( | |
| 13 | + (registration) => @updateRegistration(registration), | |
| 14 | + (error) -> console.error('Could not register service worker:', error) | |
| 15 | + ) | |
| 16 | + | |
| 17 | + update: -> | |
| 18 | + return unless @registration | |
| 19 | + @notifyUpdate = true | |
| 20 | + return @registration.update().catch(->) | |
| 21 | + | |
| 22 | + updateInBackground: -> | |
| 23 | + return unless @registration | |
| 24 | + @notifyUpdate = false | |
| 25 | + return @registration.update().catch(->) | |
| 26 | + | |
| 27 | + reload: -> | |
| 28 | + return @updateInBackground().then(() -> app.reboot()) | |
| 29 | + | |
| 30 | + updateRegistration: (registration) -> | |
| 31 | + @registration = registration | |
| 32 | + $.on @registration, 'updatefound', @onUpdateFound | |
| 33 | + return | |
| 34 | + | |
| 35 | + onUpdateFound: => | |
| 36 | + $.off @installingRegistration, 'statechange', @onStateChange() if @installingRegistration | |
| 37 | + @installingRegistration = @registration.installing | |
| 38 | + $.on @installingRegistration, 'statechange', @onStateChange | |
| 39 | + return | |
| 40 | + | |
| 41 | + onStateChange: => | |
| 42 | + if @installingRegistration and @installingRegistration.state == 'installed' and navigator.serviceWorker.controller | |
| 43 | + @installingRegistration = null | |
| 44 | + @onUpdateReady() | |
| 45 | + return | |
| 46 | + | |
| 47 | + onUpdateReady: -> | |
| 48 | + @trigger 'updateready' if @notifyUpdate | |
| 49 | + return | |
| @@ -5,11 +5,13 @@ class app.Settings · 4 unmodified lines | ||
| 5 | 5 | 'manualUpdate' |
| 6 | 6 | 'fastScroll' |
| 7 | 7 | 'arrowScroll' |
| 8 | + 'analyticsConsent' | |
| 8 | 9 | 'docs' |
| 9 | 10 | 'dark' |
| 10 | 11 | 'layout' |
| 11 | 12 | 'size' |
| 12 | 13 | 'tips' |
| 14 | + 'autoInstall' | |
| 13 | 15 | ] |
| 14 | 16 | |
| 15 | 17 | INTERNAL_KEYS = [ |
| @@ -19,6 +21,8 @@ class app.Settings · 3 unmodified lines | ||
| 19 | 21 | 'news' |
| 20 | 22 | ] |
| 21 | 23 | |
| 24 | + LAYOUTS: ['_max-width', '_sidebar-hidden', '_native-scrollbars'] | |
| 25 | + | |
| 22 | 26 | @defaults: |
| 23 | 27 | count: 0 |
| 24 | 28 | hideDisabled: false |
| @@ -26,9 +30,10 @@ class app.Settings · 1 unmodified line | ||
| 26 | 30 | news: 0 |
| 27 | 31 | manualUpdate: false |
| 28 | 32 | schema: 1 |
| 33 | + analyticsConsent: false | |
| 29 | 34 | |
| 30 | 35 | constructor: -> |
| 31 | − @store = new CookieStore | |
| 36 | + @store = new CookiesStore | |
| 32 | 37 | @cache = {} |
| 33 | 38 | |
| 34 | 39 | get: (key) -> |
| @@ -38,6 +43,7 @@ class app.Settings · 3 unmodified lines | ||
| 38 | 43 | set: (key, value) -> |
| 39 | 44 | @store.set(key, value) |
| 40 | 45 | delete @cache[key] |
| 46 | + @toggleDark(value) if key == 'dark' | |
| 41 | 47 | return |
| 42 | 48 | |
| 43 | 49 | del: (key) -> |
| @@ -63,6 +69,8 @@ class app.Settings · 19 unmodified lines | ||
| 63 | 69 | return |
| 64 | 70 | |
| 65 | 71 | setLayout: (name, enable) -> |
| 72 | + @toggleLayout(name, enable) | |
| 73 | + | |
| 66 | 74 | layout = (@store.get('layout') || '').split(' ') |
| 67 | 75 | $.arrayDelete(layout, '') |
| 68 | 76 | |
| @@ -104,3 +112,28 @@ class app.Settings · 35 unmodified lines | ||
| 104 | 112 | @store.reset() |
| 105 | 113 | @cache = {} |
| 106 | 114 | return |
| 115 | + | |
| 116 | + initLayout: -> | |
| 117 | + @toggleDark(@get('dark') is 1) | |
| 118 | + @toggleLayout(layout, @hasLayout(layout)) for layout in @LAYOUTS | |
| 119 | + @initSidebarWidth() | |
| 120 | + return | |
| 121 | + | |
| 122 | + toggleDark: (enable) -> | |
| 123 | + classList = document.documentElement.classList | |
| 124 | + classList.toggle('_theme-default', !enable) | |
| 125 | + classList.toggle('_theme-dark', enable) | |
| 126 | + color = getComputedStyle(document.documentElement).getPropertyValue('--headerBackground').trim() | |
| 127 | + $('meta[name=theme-color]').setAttribute('content', color) | |
| 128 | + return | |
| 129 | + | |
| 130 | + toggleLayout: (layout, enable) -> | |
| 131 | + classList = document.body.classList | |
| 132 | + classList.toggle(layout, enable) unless layout is '_sidebar-hidden' | |
| 133 | + classList.toggle('_overlay-scrollbars', $.overlayScrollbarsEnabled()) | |
| 134 | + return | |
| 135 | + | |
| 136 | + initSidebarWidth: -> | |
| 137 | + size = @get('size') | |
| 138 | + document.documentElement.style.setProperty('--sidebarWidth', size + 'px') if size | |
| 139 | + return | |
| @@ -3,13 +3,13 @@ class app.UpdateChecker · 2 unmodified lines | ||
| 3 | 3 | @lastCheck = Date.now() |
| 4 | 4 | |
| 5 | 5 | $.on window, 'focus', @onFocus |
| 6 | − app.appCache.on 'updateready', @onUpdateReady if app.appCache | |
| 6 | + app.serviceWorker?.on 'updateready', @onUpdateReady | |
| 7 | 7 | |
| 8 | 8 | setTimeout @checkDocs, 0 |
| 9 | 9 | |
| 10 | 10 | check: -> |
| 11 | − if app.appCache | |
| 12 | − app.appCache.update() | |
| 11 | + if app.serviceWorker | |
| 12 | + app.serviceWorker.update() | |
| 13 | 13 | else |
| 14 | 14 | ajax |
| 15 | 15 | url: $('script[src*="application"]').getAttribute('src') |
| @@ -1,4 +1,8 @@ | ||
| 1 | −class @CookieStore | |
| 1 | +class @CookiesStore | |
| 2 | + # Intentionally called CookiesStore instead of CookieStore | |
| 3 | + # Calling it CookieStore causes issues when the Experimental Web Platform features flag is enabled in Chrome | |
| 4 | + # Related issue: https://github.com/freeCodeCamp/devdocs/issues/932 | |
| 5 | + | |
| 2 | 6 | INT = /^\d+$/ |
| 3 | 7 | |
| 4 | 8 | @onBlocked: -> |
| @@ -0,0 +1,64 @@ | ||
| 1 | +defaultUrl = null | |
| 2 | +currentSlug = null | |
| 3 | + | |
| 4 | +imageCache = {} | |
| 5 | +urlCache = {} | |
| 6 | + | |
| 7 | +withImage = (url, action) -> | |
| 8 | + if imageCache[url] | |
| 9 | + action(imageCache[url]) | |
| 10 | + else | |
| 11 | + img = new Image() | |
| 12 | + img.crossOrigin = 'anonymous' | |
| 13 | + img.src = url | |
| 14 | + img.onload = () => | |
| 15 | + imageCache[url] = img | |
| 16 | + action(img) | |
| 17 | + | |
| 18 | +@setFaviconForDoc = (doc) -> | |
| 19 | + return if currentSlug == doc.slug | |
| 20 | + | |
| 21 | + favicon = $('link[rel="icon"]') | |
| 22 | + | |
| 23 | + if defaultUrl == null | |
| 24 | + defaultUrl = favicon.href | |
| 25 | + | |
| 26 | + if urlCache[doc.slug] | |
| 27 | + favicon.href = urlCache[doc.slug] | |
| 28 | + currentSlug = doc.slug | |
| 29 | + return | |
| 30 | + | |
| 31 | + styles = window.getComputedStyle($("._icon-#{doc.slug.split('~')[0]}"), ':before') | |
| 32 | + | |
| 33 | + bgUrl = app.config.favicon_spritesheet | |
| 34 | + sourceSize = 16 | |
| 35 | + sourceX = Math.abs(parseInt(styles['background-position-x'].slice(0, -2))) | |
| 36 | + sourceY = Math.abs(parseInt(styles['background-position-y'].slice(0, -2))) | |
| 37 | + | |
| 38 | + withImage(bgUrl, (docImg) -> | |
| 39 | + withImage(defaultUrl, (defaultImg) -> | |
| 40 | + size = defaultImg.width | |
| 41 | + | |
| 42 | + canvas = document.createElement('canvas') | |
| 43 | + ctx = canvas.getContext('2d') | |
| 44 | + | |
| 45 | + canvas.width = size | |
| 46 | + canvas.height = size | |
| 47 | + ctx.drawImage(defaultImg, 0, 0) | |
| 48 | + | |
| 49 | + docIconPercentage = 65 | |
| 50 | + destinationCoords = size / 100 * (100 - docIconPercentage) | |
| 51 | + destinationSize = size / 100 * docIconPercentage | |
| 52 | + ctx.drawImage(docImg, sourceX, sourceY, sourceSize, sourceSize, destinationCoords, destinationCoords, destinationSize, destinationSize) | |
| 53 | + | |
| 54 | + urlCache[doc.slug] = canvas.toDataURL() | |
| 55 | + favicon.href = urlCache[doc.slug] | |
| 56 | + | |
| 57 | + currentSlug = doc.slug | |
| 58 | + ) | |
| 59 | + ) | |
| 60 | + | |
| 61 | +@resetFavicon = () -> | |
| 62 | + if defaultUrl != null and currentSlug != null | |
| 63 | + $('link[rel="icon"]').href = defaultUrl | |
| 64 | + currentSlug = null | |
| @@ -1,5 +1,5 @@ | ||
| 1 | 1 | ### |
| 2 | − * Copyright 2013-2018 Thibaut Courouble and other contributors | |
| 2 | + * Copyright 2013-2019 Thibaut Courouble and other contributors | |
| 3 | 3 | * |
| 4 | 4 | * This source code is licensed under the terms of the Mozilla |
| 5 | 5 | * Public License, v. 2.0, a copy of which may be obtained at: |
| @@ -199,5 +199,21 @@ page.track = (fn) -> · 198 unmodified lines | ||
| 199 | 199 | return |
| 200 | 200 | |
| 201 | 201 | track = -> |
| 202 | − tracker.call() for tracker in trackers | |
| 202 | + consentGiven = Cookies.get('analyticsConsent') | |
| 203 | + consentAsked = Cookies.get('analyticsConsentAsked') | |
| 204 | + | |
| 205 | + if consentGiven == '1' | |
| 206 | + tracker.call() for tracker in trackers | |
| 207 | + else if consentGiven == undefined and consentAsked == undefined | |
| 208 | + # Only ask for consent once per browser session | |
| 209 | + Cookies.set('analyticsConsentAsked', '1') | |
| 210 | + | |
| 211 | + new app.views.Notif 'AnalyticsConsent', autoHide: null | |
| 212 | + return | |
| 213 | + | |
| 214 | +@resetAnalytics = -> | |
| 215 | + for cookie in document.cookie.split(/;\s?/) | |
| 216 | + name = cookie.split('=')[0] | |
| 217 | + if name[0] == '_' && name[1] != '_' | |
| 218 | + Cookies.expire(name) | |
| 203 | 219 | return |
| @@ -352,6 +352,10 @@ isIE = null · 351 unmodified lines | ||
| 352 | 352 | $.isIE = -> |
| 353 | 353 | isIE ?= navigator.userAgent?.indexOf('MSIE') >= 0 || navigator.userAgent?.indexOf('rv:11.0') >= 0 |
| 354 | 354 | |
| 355 | +isChromeForAndroid = null | |
| 356 | +$.isChromeForAndroid = -> | |
| 357 | + isChromeForAndroid ?= navigator.userAgent?.indexOf('Android') >= 0 && /Chrome\/([.0-9])+ Mobile/.test(navigator.userAgent) | |
| 358 | + | |
| 355 | 359 | isAndroid = null |
| 356 | 360 | $.isAndroid = -> |
| 357 | 361 | isAndroid ?= navigator.userAgent?.indexOf('Android') >= 0 |
| @@ -142,4 +142,6 @@ class app.models.Doc extends app.Model · 141 unmodified lines | ||
| 142 | 142 | return |
| 143 | 143 | |
| 144 | 144 | isOutdated: (status) -> |
| 145 | − status and status.installed and @mtime isnt status.mtime | |
| 145 | + return false if not status | |
| 146 | + isInstalled = status.installed or app.settings.get('autoInstall') | |
| 147 | + isInstalled and @mtime isnt status.mtime | |
| @@ -1,4 +1,12 @@ | ||
| 1 | 1 | [ |
| 2 | + [ | |
| 3 | + "2019-07-21", | |
| 4 | + "Fixed several bugs, added an option to automatically download documentation and <a href=\"https://github.com/freeCodeCamp/devdocs/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc+closed%3A%3E2019-07-18+977+988+986+870+886+1024+979+975+941+831+1005+848+942\" target=\"_blank\">more</a>." | |
| 5 | + ], | |
| 6 | + [ | |
| 7 | + "2019-07-19", | |
| 8 | + "Replaced the AppCache with a Service Worker (which makes DevDocs an installable PWA) and fixed layout preferences on Firefox." | |
| 9 | + ], | |
| 2 | 10 | [ |
| 3 | 11 | "2018-09-23", |
| 4 | 12 | "New documentations: <a href=\"/puppeteer/\">Puppeteer</a> and <a href=\"/handlebars/\">Handlebars.js</a>" |
| @@ -12,8 +12,8 @@ app.templates.notFoundPage = -> · 11 unmodified lines | ||
| 12 | 12 | |
| 13 | 13 | app.templates.pageLoadError = -> |
| 14 | 14 | error """ The page failed to load. """, |
| 15 | − """ It may be missing from the server (try reloading the app) or you could be offline.<br> | |
| 16 | − If you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """, | |
| 15 | + """ It may be missing from the server (try reloading the app) or you could be offline (try <a href="/offline">installing the documentation for offline usage</a> when online again).<br> | |
| 16 | + If you're online and you keep seeing this, you're likely behind a proxy or firewall that blocks cross-domain requests. """, | |
| 17 | 17 | """ #{back} · <a href="/##{location.pathname}" target="_top" class="_error-link">Reload</a> |
| 18 | 18 | · <a href="#" class="_error-link" data-retry>Retry</a> """ |
| 19 | 19 | |
| @@ -57,17 +57,17 @@ app.templates.unsupportedBrowser = """ · 37 unmodified lines | ||
| 57 | 57 | <p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers: |
| 58 | 58 | <ul class="_fail-list"> |
| 59 | 59 | <li>Recent versions of Firefox, Chrome, or Opera |
| 60 | − <li>Safari 9.1+ | |
| 61 | − <li>Edge 16+ | |
| 62 | − <li>iOS 10+ | |
| 60 | + <li>Safari 11.1+ | |
| 61 | + <li>Edge 17+ | |
| 62 | + <li>iOS 11.3+ | |
| 63 | 63 | </ul> |
| 64 | 64 | <p class="_fail-text"> |
| 65 | − If you're unable to upgrade, I apologize. | |
| 66 | − I decided to prioritize speed and new features over support for older browsers. | |
| 65 | + If you're unable to upgrade, we apologize. | |
| 66 | + We decided to prioritize speed and new features over support for older browsers. | |
| 67 | 67 | <p class="_fail-text"> |
| 68 | 68 | Note: if you're already using one of the browsers above, check your settings and add-ons. |
| 69 | 69 | The app uses feature detection, not user agent sniffing. |
| 70 | 70 | <p class="_fail-text"> |
| 71 | − — Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a> | |
| 71 | + — <a href="https://twitter.com/DevDocs">@DevDocs</a> | |
| 72 | 72 | </div> |
| 73 | 73 | """ |
| @@ -68,3 +68,9 @@ app.templates.notifShare = -> · 67 unmodified lines | ||
| 68 | 68 | app.templates.notifUpdateDocs = -> |
| 69 | 69 | textNotif """ Documentation updates available. """, |
| 70 | 70 | """ <a href="/offline">Install them</a> as soon as possible to avoid broken pages. """ |
| 71 | + | |
| 72 | +app.templates.notifAnalyticsConsent = -> | |
| 73 | + textNotif """ Tracking cookies """, | |
| 74 | + """ We would like to gather usage data about how DevDocs is used through Google Analytics and Gauges. We only collect anonymous traffic information. | |
| 75 | + Please confirm if you accept our tracking cookies. You can always change your decision in the settings. | |
| 76 | + <br><span class="_notif-right"><a href="#" data-behavior="accept-analytics">Accept</a> or <a href="#" data-behavior="decline-analytics">Decline</a></span> """ | |
| @@ -11,22 +11,18 @@ app.templates.aboutPage = -> """ · 10 unmodified lines | ||
| 11 | 11 | </nav> |
| 12 | 12 | |
| 13 | 13 | <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1> |
| 14 | − <p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 15 | − <ul> | |
| 16 | − <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a> | |
| 17 | − <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a> | |
| 18 | − <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe> | |
| 19 | − </ul> | |
| 14 | + <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 15 | + <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>. | |
| 20 | 16 | <p>To keep up-to-date with the latest news: |
| 21 | 17 | <ul> |
| 22 | 18 | <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter |
| 23 | − <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> | |
| 24 | − <li>Join the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a> | |
| 19 | + <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe> | |
| 20 | + <li>Join the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room | |
| 25 | 21 | </ul> |
| 26 | 22 | |
| 27 | 23 | <h2 class="_block-heading" id="copyright">Copyright and License</h2> |
| 28 | 24 | <p class="_note"> |
| 29 | − <strong>Copyright 2013–2018 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br> | |
| 25 | + <strong>Copyright 2013–2019 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br> | |
| 30 | 26 | This software is licensed under the terms of the Mozilla Public License v2.0.<br> |
| 31 | 27 | You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br> |
| 32 | 28 | For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> |
| @@ -48,11 +44,10 @@ app.templates.aboutPage = -> """ · 15 unmodified lines | ||
| 48 | 44 | <dt>Where can I suggest new docs and features? |
| 49 | 45 | <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br> |
| 50 | 46 | If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br> |
| 51 | − Otherwise use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>. | |
| 47 | + Otherwise, come talk to us in the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room. | |
| 52 | 48 | <dt>Where can I report bugs? |
| 53 | 49 | <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks! |
| 54 | 50 | </dl> |
| 55 | − <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>. | |
| 56 | 51 | |
| 57 | 52 | <h2 class="_block-heading" id="credits">Credits</h2> |
| 58 | 53 | |
| @@ -76,12 +71,13 @@ app.templates.aboutPage = -> """ · 17 unmodified lines | ||
| 76 | 71 | |
| 77 | 72 | <h2 class="_block-heading" id="privacy">Privacy Policy</h2> |
| 78 | 73 | <ul> |
| 79 | − <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by Thibaut Courouble ("We"). | |
| 80 | − <li>We do not collect personal information. | |
| 81 | − <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app. | |
| 74 | + <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We"). | |
| 75 | + <li>We do not collect personal information through the app. | |
| 76 | + <li>We use Google Analytics and Gauges to collect anonymous traffic information if you have given consent to this. You can change your decision in the <a href="/settings">settings</a>. | |
| 77 | + <li>We use Sentry to collect crash data and improve the app. | |
| 82 | 78 | <li>The app uses cookies to store user preferences. |
| 83 | 79 | <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app. |
| 84 | − <li>If you have any questions regarding privacy, please email <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>. | |
| 80 | + <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>. | |
| 85 | 81 | </ul> |
| 86 | 82 | """ |
| 87 | 83 | |
| @@ -92,7 +88,7 @@ credits = [ · 4 unmodified lines | ||
| 92 | 88 | 'https://creativecommons.org/licenses/by/4.0/' |
| 93 | 89 | ], [ |
| 94 | 90 | 'Ansible', |
| 95 | − '2012-2018 Michael DeHaan<br>© 2018 Red Hat, Inc.', | |
| 91 | + '2012-2018 Michael DeHaan<br>© 2018–2019 Red Hat, Inc.', | |
| 96 | 92 | 'GPLv3', |
| 97 | 93 | 'https://raw.githubusercontent.com/ansible/ansible/devel/COPYING' |
| 98 | 94 | ], [ |
| @@ -127,7 +123,7 @@ credits = [ · 28 unmodified lines | ||
| 127 | 123 | 'https://raw.githubusercontent.com/petkaantonov/bluebird/master/LICENSE' |
| 128 | 124 | ], [ |
| 129 | 125 | 'Bootstrap', |
| 130 | − '2011-2018 Twitter, Inc.<br>2011-2018 The Bootstrap Authors', | |
| 126 | + '2011-2019 Twitter, Inc.<br>2011-2019 The Bootstrap Authors', | |
| 131 | 127 | 'CC BY', |
| 132 | 128 | 'https://creativecommons.org/licenses/by/3.0/' |
| 133 | 129 | ], [ |
| @@ -167,7 +163,7 @@ credits = [ · 33 unmodified lines | ||
| 167 | 163 | 'https://github.com/clojure/clojure/blob/master/epl-v10.html' |
| 168 | 164 | ], [ |
| 169 | 165 | 'CMake', |
| 170 | − '2000-2018 Kitware, Inc. and Contributors', | |
| 166 | + '2000-2019 Kitware, Inc. and Contributors', | |
| 171 | 167 | 'BSD', |
| 172 | 168 | 'https://cmake.org/licensing/' |
| 173 | 169 | ], [ |
| @@ -190,6 +186,11 @@ credits = [ · 16 unmodified lines | ||
| 190 | 186 | '2009-2018 Jeremy Ashkenas', |
| 191 | 187 | 'MIT', |
| 192 | 188 | 'https://raw.githubusercontent.com/jashkenas/coffeescript/master/LICENSE' |
| 189 | + ], [ | |
| 190 | + 'Composer', | |
| 191 | + 'Nils Adermann, Jordi Boggiano', | |
| 192 | + 'MIT', | |
| 193 | + 'https://raw.githubusercontent.com/composer/composer/master/LICENSE' | |
| 193 | 194 | ], [ |
| 194 | 195 | 'Cordova', |
| 195 | 196 | '2012-2018 The Apache Software Foundation', |
| @@ -206,6 +207,12 @@ credits = [ · 10 unmodified lines | ||
| 206 | 207 | 'Apache', |
| 207 | 208 | 'https://raw.githubusercontent.com/crystal-lang/crystal/master/LICENSE' |
| 208 | 209 | ], [ |
| 210 | + 'Cypress', | |
| 211 | + '2017 Cypress.io', | |
| 212 | + 'MIT', | |
| 213 | + 'https://raw.githubusercontent.com/cypress-io/cypress-documentation/develop/LICENSE.md' | |
| 214 | + ], | |
| 215 | + [ | |
| 209 | 216 | 'D', |
| 210 | 217 | '1999-2018 The D Language Foundation', |
| 211 | 218 | 'Boost', |
| @@ -227,7 +234,7 @@ credits = [ · 15 unmodified lines | ||
| 227 | 234 | 'https://raw.githubusercontent.com/django/django/master/LICENSE' |
| 228 | 235 | ], [ |
| 229 | 236 | 'Docker', |
| 230 | − '2017 Docker, Inc.<br>Docker and the Docker logo are trademarks of Docker, Inc.', | |
| 237 | + '2019 Docker, Inc.<br>Docker and the Docker logo are trademarks of Docker, Inc.', | |
| 231 | 238 | 'Apache', |
| 232 | 239 | 'https://raw.githubusercontent.com/docker/docker.github.io/master/LICENSE' |
| 233 | 240 | ], [ |
| @@ -392,7 +399,7 @@ credits = [ · 158 unmodified lines | ||
| 392 | 399 | 'https://raw.githubusercontent.com/koajs/koa/master/LICENSE' |
| 393 | 400 | ], [ |
| 394 | 401 | 'Kotlin', |
| 395 | − '2010-2018 JetBrains s.r.o.', | |
| 402 | + '2010-2019 JetBrains s.r.o.', | |
| 396 | 403 | 'Apache', |
| 397 | 404 | 'https://raw.githubusercontent.com/JetBrains/kotlin/master/license/LICENSE.txt' |
| 398 | 405 | ], [ |
| @@ -402,7 +409,7 @@ credits = [ · 3 unmodified lines | ||
| 402 | 409 | 'https://raw.githubusercontent.com/laravel/framework/master/LICENSE.txt' |
| 403 | 410 | ], [ |
| 404 | 411 | 'Leaflet', |
| 405 | − '2010-2018 Vladimir Agafonkin<br>© 2010-2011, CloudMade<br>Maps © OpenStreetMap contributors.', | |
| 412 | + '2010-2019 Vladimir Agafonkin<br>© 2010-2011, CloudMade<br>Maps © OpenStreetMap contributors.', | |
| 406 | 413 | 'BSD', |
| 407 | 414 | 'https://raw.githubusercontent.com/Leaflet/Leaflet/master/LICENSE' |
| 408 | 415 | ], [ |
| @@ -477,7 +484,7 @@ credits = [ · 68 unmodified lines | ||
| 477 | 484 | 'https://github.com/LearnBoost/mongoose/blob/master/README.md#license' |
| 478 | 485 | ], [ |
| 479 | 486 | 'nginx', |
| 480 | − '2002-2018 Igor Sysoev<br>© 2011-2018 Nginx, Inc.', | |
| 487 | + '2002-2019 Igor Sysoev<br>© 2011-2019 Nginx, Inc.', | |
| 481 | 488 | 'BSD', |
| 482 | 489 | 'http://nginx.org/LICENSE' |
| 483 | 490 | ], [ |
| @@ -522,7 +529,7 @@ credits = [ · 38 unmodified lines | ||
| 522 | 529 | 'https://raw.githubusercontent.com/OpenTSDB/opentsdb.net/gh-pages/COPYING.LESSER' |
| 523 | 530 | ], [ |
| 524 | 531 | 'Padrino', |
| 525 | − '2010-2016 Padrino', | |
| 532 | + '2010-2019 Padrino', | |
| 526 | 533 | 'MIT', |
| 527 | 534 | 'https://raw.githubusercontent.com/padrino/padrino-framework/master/padrino/LICENSE.txt' |
| 528 | 535 | ], [ |
| @@ -572,7 +579,7 @@ credits = [ · 43 unmodified lines | ||
| 572 | 579 | 'https://raw.githubusercontent.com/GoogleChrome/puppeteer/master/LICENSE' |
| 573 | 580 | ], [ |
| 574 | 581 | 'Pygame', |
| 575 | − 'Pygame Developpers', | |
| 582 | + 'Pygame Developers', | |
| 576 | 583 | 'LGPLv2.1', |
| 577 | 584 | 'https://raw.githubusercontent.com/pygame/pygame/master/LICENSE' |
| 578 | 585 | ], [ |
| @@ -636,11 +643,23 @@ credits = [ · 57 unmodified lines | ||
| 636 | 643 | 'MIT', |
| 637 | 644 | 'https://raw.githubusercontent.com/rust-lang/rust/master/LICENSE-MIT' |
| 638 | 645 | ], [ |
| 646 | + 'Salt Stack', | |
| 647 | + '2019 SaltStack', | |
| 648 | + 'Apache', | |
| 649 | + 'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE' | |
| 650 | + ], | |
| 651 | + [ | |
| 639 | 652 | 'Sass', |
| 640 | 653 | '2006-2016 Hampton Catlin, Nathan Weizenbaum, and Chris Eppstein', |
| 641 | 654 | 'MIT', |
| 642 | 655 | 'https://raw.githubusercontent.com/sass/sass/stable/MIT-LICENSE' |
| 643 | 656 | ], [ |
| 657 | + 'Scala', | |
| 658 | + '2002-2019 EPFL, with contributions from Lightbend', | |
| 659 | + 'Apache', | |
| 660 | + 'https://raw.githubusercontent.com/scala/scala-lang/master/license.md' | |
| 661 | + ], | |
| 662 | + [ | |
| 644 | 663 | 'scikit-image', |
| 645 | 664 | '2011 the scikit-image team', |
| 646 | 665 | 'BSD', |
| @@ -710,11 +729,21 @@ credits = [ · 63 unmodified lines | ||
| 710 | 729 | '2010-2018 Mitchell Hashimoto', |
| 711 | 730 | 'MPL', |
| 712 | 731 | 'https://raw.githubusercontent.com/mitchellh/vagrant/master/website/LICENSE.md' |
| 732 | + ], [ | |
| 733 | + 'Vue Router', | |
| 734 | + '2013-present Evan You', | |
| 735 | + 'MIT', | |
| 736 | + 'https://raw.githubusercontent.com/vuejs/vue-router/dev/LICENSE' | |
| 713 | 737 | ], [ |
| 714 | 738 | 'Vue.js', |
| 715 | 739 | '2013-2018 Evan You, Vue.js contributors', |
| 716 | 740 | 'MIT', |
| 717 | 741 | 'https://raw.githubusercontent.com/vuejs/vue/master/LICENSE' |
| 742 | + ], [ | |
| 743 | + 'Vuex', | |
| 744 | + '2015-present Evan You', | |
| 745 | + 'MIT', | |
| 746 | + 'https://raw.githubusercontent.com/vuejs/vuex/dev/LICENSE' | |
| 718 | 747 | ], [ |
| 719 | 748 | 'Vulkan', |
| 720 | 749 | '2014-2017 Khronos Group Inc.<br>Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.', |
| @@ -726,6 +755,12 @@ credits = [ · 5 unmodified lines | ||
| 726 | 755 | 'CC BY', |
| 727 | 756 | 'https://creativecommons.org/licenses/by/4.0/' |
| 728 | 757 | ], [ |
| 758 | + 'Wordpress', | |
| 759 | + '2003-2019 WordPress Foundation', | |
| 760 | + 'GPLv2+', | |
| 761 | + 'https://wordpress.org/about/license/' | |
| 762 | + ], | |
| 763 | + [ | |
| 729 | 764 | 'Yarn', |
| 730 | 765 | '2016-present Yarn Contributors', |
| 731 | 766 | 'BSD', |
| @@ -25,8 +25,8 @@ app.templates.offlinePage = (docs) -> """ · 24 unmodified lines | ||
| 25 | 25 | <h2 class="_block-heading">Questions & Answers</h2> |
| 26 | 26 | <dl> |
| 27 | 27 | <dt>How does this work? |
| 28 | − <dd>Each page is cached as a key-value pair in <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> (downloaded from a single file).<br> | |
| 29 | − The app also uses <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache">AppCache</a> and <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">localStorage</a> to cache the assets and index files. | |
| 28 | + <dd>Each page is cached as a key-value pair in <a href="https://devdocs.io/dom/indexeddb_api">IndexedDB</a> (downloaded from a single file).<br> | |
| 29 | + The app also uses <a href="https://devdocs.io/dom/service_worker_api/using_service_workers">Service Workers</a> and <a href="https://devdocs.io/dom/web_storage_api">localStorage</a> to cache the assets and index files. | |
| 30 | 30 | <dt>Can I close the tab/browser? |
| 31 | 31 | <dd>#{canICloseTheTab()} |
| 32 | 32 | <dt>What if I don't update a documentation? |
| @@ -41,10 +41,15 @@ app.templates.offlinePage = (docs) -> """ · 8 unmodified lines | ||
| 41 | 41 | """ |
| 42 | 42 | |
| 43 | 43 | canICloseTheTab = -> |
| 44 | − if app.AppCache.isEnabled() | |
| 44 | + if app.ServiceWorker.isEnabled() | |
| 45 | 45 | """ Yes! Even offline, you can open a new tab, go to <a href="//devdocs.io">devdocs.io</a>, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """ |
| 46 | 46 | else |
| 47 | − """ No. AppCache isn't available in your browser (or is disabled), so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br> | |
| 47 | + reason = "aren't available in your browser (or are disabled)" | |
| 48 | + | |
| 49 | + if app.config.env != 'production' | |
| 50 | + reason = "are disabled in your development instance of DevDocs (enable them by setting the <code>ENABLE_SERVICE_WORKER</code> environment variable to <code>true</code>)" | |
| 51 | + | |
| 52 | + """ No. Service Workers #{reason}, so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br> | |
| 48 | 53 | The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """ |
| 49 | 54 | |
| 50 | 55 | app.templates.offlineDoc = (doc, status) -> |
| @@ -8,13 +8,13 @@ app.templates.intro = """ · 7 unmodified lines | ||
| 8 | 8 | <p>Thanks for downloading DevDocs. Here are a few things you should know: |
| 9 | 9 | <ol class="_intro-list"> |
| 10 | 10 | <li>Your local version of DevDocs won't self-update. Unless you're modifying the code, |
| 11 | − I recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>. | |
| 11 | + we recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>. | |
| 12 | 12 | <li>Run <code>thor docs:list</code> to see all available documentations. |
| 13 | 13 | <li>Run <code>thor docs:download <name></code> to download documentations. |
| 14 | 14 | <li>Run <code>thor docs:download --installed</code> to update all downloaded documentations. |
| 15 | 15 | <li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub. |
| 16 | 16 | <li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and |
| 17 | − feature requests. For everything else, use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>. | |
| 17 | + feature requests. For everything else, use <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a>. | |
| 18 | 18 | <li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>. |
| 19 | 19 | <li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information, |
| 20 | 20 | see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and |
| @@ -39,7 +39,7 @@ app.templates.intro = """ · 18 unmodified lines | ||
| 39 | 39 | <li>DevDocs works <a href="/offline">offline</a>, on mobile, and can be installed on <a href="https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe">Chrome</a>. |
| 40 | 40 | <li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>. |
| 41 | 41 | <li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. |
| 42 | − <iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe> | |
| 42 | + <object data="https://img.shields.io/github/stars/freeCodeCamp/devdocs.svg?style=social" type="image/svg+xml" aria-hidden="true"></object> | |
| 43 | 43 | <li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>. |
| 44 | 44 | </ol> |
| 45 | 45 | <p>Happy coding! |
| @@ -15,6 +15,14 @@ app.templates.settingsPage = (settings) -> """ · 14 unmodified lines | ||
| 15 | 15 | <input type="checkbox" form="settings" name="layout" value="_sidebar-hidden"#{if settings['_sidebar-hidden'] then ' checked' else ''}>Automatically hide and show the sidebar |
| 16 | 16 | <small>Tip: drag the edge of the sidebar to resize it.</small> |
| 17 | 17 | </label> |
| 18 | + <label class="_settings-label"> | |
| 19 | + <input type="checkbox" form="settings" name="autoInstall" value="_auto-install"#{if settings.autoInstall then ' checked' else ''}>Automatically download documentation for offline use | |
| 20 | + <small>Only enable this when bandwidth isn't a concern to you.</small> | |
| 21 | + </label> | |
| 22 | + <label class="_settings-label"> | |
| 23 | + <input type="checkbox" form="settings" name="analyticsConsent"#{if settings.analyticsConsent then ' checked' else ''}>Enable tracking cookies | |
| 24 | + <small>With this checked, we enable Google Analytics and Gauges to collect anonymous traffic information.</small> | |
| 25 | + </label> | |
| 18 | 26 | </div> |
| 19 | 27 | </div> |
| 20 | 28 | |
| @@ -1,28 +1,32 @@ | ||
| 1 | 1 | try { |
| 2 | − if (app.config.env == 'production') { | |
| 3 | − (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | |
| 4 | − (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | |
| 5 | − m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | |
| 6 | − })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); | |
| 7 | − ga('create', 'UA-5544833-12', 'devdocs.io'); | |
| 8 | − page.track(function() { | |
| 9 | − ga('send', 'pageview', { | |
| 10 | − page: location.pathname + location.search + location.hash, | |
| 11 | − dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version | |
| 2 | + if (app.config.env === 'production') { | |
| 3 | + if (Cookies.get('analyticsConsent') === '1') { | |
| 4 | + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | |
| 5 | + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | |
| 6 | + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | |
| 7 | + })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); | |
| 8 | + ga('create', 'UA-5544833-12', 'devdocs.io'); | |
| 9 | + page.track(function() { | |
| 10 | + ga('send', 'pageview', { | |
| 11 | + page: location.pathname + location.search + location.hash, | |
| 12 | + dimension1: app.router.context && app.router.context.doc && app.router.context.doc.slug_without_version | |
| 13 | + }); | |
| 12 | 14 | }); |
| 13 | − }); | |
| 14 | 15 | |
| 15 | − page.track(function() { | |
| 16 | − if (window._gauges) | |
| 17 | − _gauges.push(['track']); | |
| 18 | − else | |
| 19 | − (function() { | |
| 20 | − var _gauges=_gauges||[];!function(){var a=document.createElement("script"); | |
| 21 | − a.type="text/javascript",a.async=!0,a.id="gauges-tracker", | |
| 22 | − a.setAttribute("data-site-id","51c15f82613f5d7819000067"), | |
| 23 | − a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0]; | |
| 24 | − b.parentNode.insertBefore(a,b)}(); | |
| 25 | − })(); | |
| 26 | − }); | |
| 16 | + page.track(function() { | |
| 17 | + if (window._gauges) | |
| 18 | + _gauges.push(['track']); | |
| 19 | + else | |
| 20 | + (function() { | |
| 21 | + var _gauges=_gauges||[];!function(){var a=document.createElement("script"); | |
| 22 | + a.type="text/javascript",a.async=!0,a.id="gauges-tracker", | |
| 23 | + a.setAttribute("data-site-id","51c15f82613f5d7819000067"), | |
| 24 | + a.src="https://secure.gaug.es/track.js";var b=document.getElementsByTagName("script")[0]; | |
| 25 | + b.parentNode.insertBefore(a,b)}(); | |
| 26 | + })(); | |
| 27 | + }); | |
| 28 | + } else { | |
| 29 | + resetAnalytics(); | |
| 30 | + } | |
| 27 | 31 | } |
| 28 | 32 | } catch(e) { } |
| @@ -413,7 +413,7 @@ · 412 unmodified lines | ||
| 413 | 413 | // when the user next taps anywhere else on the page, new touchstart and touchend events are dispatched |
| 414 | 414 | // with the same identifier as the touch event that previously triggered the click that triggered the alert. |
| 415 | 415 | // Sadly, there is an issue on iOS 4 that causes some normal touch events to have the same identifier as an |
| 416 | − // immediately preceeding touch event (issue #52), so this fix is unavailable on that platform. | |
| 416 | + // immediately preceding touch event (issue #52), so this fix is unavailable on that platform. | |
| 417 | 417 | // Issue 120: touch.identifier is 0 when Chrome dev tools 'Emulate touch events' is set with an iOS device UA string, |
| 418 | 418 | // which causes all touch events to be ignored. As this block only applies to iOS, and iOS identifiers are always long, |
| 419 | 419 | // random integers, it's safe to to continue if the identifier is 0 here. |
| @@ -805,7 +805,7 @@ · 385 unmodified lines | ||
| 805 | 805 | } |
| 806 | 806 | } |
| 807 | 807 | |
| 808 | − // IE11: prefixed -ms-touch-action is no longer supported and it's recomended to use non-prefixed version | |
| 808 | + // IE11: prefixed -ms-touch-action is no longer supported and it's recommended to use non-prefixed version | |
| 809 | 809 | // http://msdn.microsoft.com/en-us/library/windows/apps/Hh767313.aspx |
| 810 | 810 | if (layer.style.touchAction === 'none' || layer.style.touchAction === 'manipulation') { |
| 811 | 811 | return true; |
| @@ -856,7 +856,7 @@ Raven.prototype = { · 855 unmodified lines | ||
| 856 | 856 | }, |
| 857 | 857 | |
| 858 | 858 | _triggerEvent: function(eventType, options) { |
| 859 | − // NOTE: `event` is a native browser thing, so let's avoid conflicting wiht it | |
| 859 | + // NOTE: `event` is a native browser thing, so let's avoid conflicting with it | |
| 860 | 860 | var evt, key; |
| 861 | 861 | |
| 862 | 862 | if (!this._hasDocument) return; |
| @@ -153,6 +153,9 @@ class app.views.Content extends app.View · 152 unmodified lines | ||
| 153 | 153 | return |
| 154 | 154 | |
| 155 | 155 | afterRoute: (route, context) => |
| 156 | + if route != 'entry' and route != 'type' | |
| 157 | + resetFavicon() | |
| 158 | + | |
| 156 | 159 | switch route |
| 157 | 160 | when 'root' |
| 158 | 161 | @show @rootPage |
| @@ -40,6 +40,7 @@ class app.views.EntryPage extends app.View · 39 unmodified lines | ||
| 40 | 40 | if app.disabledDocs.findBy 'slug', @entry.doc.slug |
| 41 | 41 | @hiddenView = new app.views.HiddenPage @el, @entry |
| 42 | 42 | |
| 43 | + setFaviconForDoc(@entry.doc) | |
| 43 | 44 | @delay @polyfillMathML |
| 44 | 45 | @trigger 'loaded' |
| 45 | 46 | return |
| @@ -123,7 +124,7 @@ class app.views.EntryPage extends app.View · 77 unmodified lines | ||
| 123 | 124 | @render @tmpl('pageLoadError') |
| 124 | 125 | @resetClass() |
| 125 | 126 | @addClass @constructor.errorClass |
| 126 | − app.appCache?.update() | |
| 127 | + app.serviceWorker?.update() | |
| 127 | 128 | return |
| 128 | 129 | |
| 129 | 130 | cache: -> |
| @@ -1,7 +1,4 @@ | ||
| 1 | 1 | class app.views.SettingsPage extends app.View |
| 2 | − LAYOUTS = ['_max-width', '_sidebar-hidden', '_native-scrollbars'] | |
| 3 | − SIDEBAR_HIDDEN_LAYOUT = '_sidebar-hidden' | |
| 4 | − | |
| 5 | 2 | @className: '_static' |
| 6 | 3 | |
| 7 | 4 | @events: |
| @@ -17,31 +14,31 @@ class app.views.SettingsPage extends app.View · 9 unmodified lines | ||
| 17 | 14 | settings.dark = app.settings.get('dark') |
| 18 | 15 | settings.smoothScroll = !app.settings.get('fastScroll') |
| 19 | 16 | settings.arrowScroll = app.settings.get('arrowScroll') |
| 20 | − settings[layout] = app.settings.hasLayout(layout) for layout in LAYOUTS | |
| 17 | + settings.autoInstall = app.settings.get('autoInstall') | |
| 18 | + settings.analyticsConsent = app.settings.get('analyticsConsent') | |
| 19 | + settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS | |
| 21 | 20 | settings |
| 22 | 21 | |
| 23 | 22 | getTitle: -> |
| 24 | 23 | 'Preferences' |
| 25 | 24 | |
| 26 | 25 | toggleDark: (enable) -> |
| 27 | − html = document.documentElement | |
| 28 | − html.classList.toggle('_theme-default') | |
| 29 | − html.classList.toggle('_theme-dark') | |
| 30 | 26 | app.settings.set('dark', !!enable) |
| 31 | − app.appCache?.updateInBackground() | |
| 32 | 27 | return |
| 33 | 28 | |
| 34 | 29 | toggleLayout: (layout, enable) -> |
| 35 | − document.body.classList[if enable then 'add' else 'remove'](layout) unless layout is SIDEBAR_HIDDEN_LAYOUT | |
| 36 | − document.body.classList[if $.overlayScrollbarsEnabled() then 'add' else 'remove']('_overlay-scrollbars') | |
| 37 | 30 | app.settings.setLayout(layout, enable) |
| 38 | − app.appCache?.updateInBackground() | |
| 39 | 31 | return |
| 40 | 32 | |
| 41 | 33 | toggleSmoothScroll: (enable) -> |
| 42 | 34 | app.settings.set('fastScroll', !enable) |
| 43 | 35 | return |
| 44 | 36 | |
| 37 | + toggleAnalyticsConsent: (enable) -> | |
| 38 | + app.settings.set('analyticsConsent', if enable then '1' else '0') | |
| 39 | + resetAnalytics() unless enable | |
| 40 | + return | |
| 41 | + | |
| 45 | 42 | toggle: (name, enable) -> |
| 46 | 43 | app.settings.set(name, enable) |
| 47 | 44 | return |
| @@ -85,6 +82,8 @@ class app.views.SettingsPage extends app.View · 37 unmodified lines | ||
| 85 | 82 | @toggleSmoothScroll input.checked |
| 86 | 83 | when 'import' |
| 87 | 84 | @import input.files[0], input |
| 85 | + when 'analyticsConsent' | |
| 86 | + @toggleAnalyticsConsent input.checked | |
| 88 | 87 | else |
| 89 | 88 | @toggle input.name, input.checked |
| 90 | 89 | return |
| @@ -9,6 +9,7 @@ class app.views.TypePage extends app.View · 8 unmodified lines | ||
| 9 | 9 | |
| 10 | 10 | render: (@type) -> |
| 11 | 11 | @html @tmpl('typePage', @type) |
| 12 | + setFaviconForDoc(@type.doc) | |
| 12 | 13 | return |
| 13 | 14 | |
| 14 | 15 | getTitle: -> |
| @@ -75,9 +75,11 @@ class app.views.Document extends app.View · 74 unmodified lines | ||
| 75 | 75 | return unless target.hasAttribute('data-behavior') |
| 76 | 76 | $.stopEvent(event) |
| 77 | 77 | switch target.getAttribute('data-behavior') |
| 78 | − when 'back' then history.back() | |
| 79 | − when 'reload' then window.location.reload() | |
| 80 | − when 'reboot' then app.reboot() | |
| 81 | − when 'hard-reload' then app.reload() | |
| 82 | − when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?') | |
| 78 | + when 'back' then history.back() | |
| 79 | + when 'reload' then window.location.reload() | |
| 80 | + when 'reboot' then app.reboot() | |
| 81 | + when 'hard-reload' then app.reload() | |
| 82 | + when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?') | |
| 83 | + when 'accept-analytics' then Cookies.set('analyticsConsent', '1', expires: 1e8) && app.reboot() | |
| 84 | + when 'decline-analytics' then Cookies.set('analyticsConsent', '0', expires: 1e8) && app.reboot() | |
| 83 | 85 | return |
| @@ -11,9 +11,6 @@ class app.views.Resizer extends app.View · 10 unmodified lines | ||
| 11 | 11 | init: -> |
| 12 | 12 | @el.setAttribute('draggable', 'true') |
| 13 | 13 | @appendTo $('._app') |
| 14 | − | |
| 15 | − @style = $('style[data-resizer]') | |
| 16 | − @size = @style.getAttribute('data-size') | |
| 17 | 14 | return |
| 18 | 15 | |
| 19 | 16 | MIN = 260 |
| @@ -24,15 +21,11 @@ class app.views.Resizer extends app.View · 4 unmodified lines | ||
| 24 | 21 | return unless value > 0 |
| 25 | 22 | value = Math.min(Math.max(Math.round(value), MIN), MAX) |
| 26 | 23 | newSize = "#{value}px" |
| 27 | − @style.innerHTML = @style.innerHTML.replace(new RegExp(@size, 'g'), newSize) | |
| 28 | − @size = newSize | |
| 29 | − if save | |
| 30 | − app.settings.setSize(value) | |
| 31 | − app.appCache?.updateInBackground() | |
| 24 | + document.documentElement.style.setProperty('--sidebarWidth', newSize) | |
| 25 | + app.settings.setSize(value) if save | |
| 32 | 26 | return |
| 33 | 27 | |
| 34 | 28 | onDragStart: (event) => |
| 35 | − @style.removeAttribute('disabled') | |
| 36 | 29 | event.dataTransfer.effectAllowed = 'link' |
| 37 | 30 | event.dataTransfer.setData('Text', '') |
| 38 | 31 | $.on(window, 'dragover', @onDrag) |
| @@ -25,7 +25,6 @@ class app.views.Settings extends app.View · 24 unmodified lines | ||
| 25 | 25 | if super |
| 26 | 26 | @render() |
| 27 | 27 | document.body.classList.remove(SIDEBAR_HIDDEN_LAYOUT) |
| 28 | − app.appCache?.on 'progress', @onAppCacheProgress | |
| 29 | 28 | return |
| 30 | 29 | |
| 31 | 30 | deactivate: -> |
| @@ -33,7 +32,6 @@ class app.views.Settings extends app.View · 1 unmodified line | ||
| 33 | 32 | @resetClass() |
| 34 | 33 | @docPicker.detach() |
| 35 | 34 | document.body.classList.add(SIDEBAR_HIDDEN_LAYOUT) if app.settings.hasLayout(SIDEBAR_HIDDEN_LAYOUT) |
| 36 | − app.appCache?.off 'progress', @onAppCacheProgress | |
| 37 | 35 | return |
| 38 | 36 | |
| 39 | 37 | render: -> |
| @@ -52,7 +50,7 @@ class app.views.Settings extends app.View · 12 unmodified lines | ||
| 52 | 50 | docs = @docPicker.getSelectedDocs() |
| 53 | 51 | app.settings.setDocs(docs) |
| 54 | 52 | |
| 55 | − @saveBtn.textContent = if app.appCache then 'Downloading\u2026' else 'Saving\u2026' | |
| 53 | + @saveBtn.textContent = 'Saving\u2026' | |
| 56 | 54 | disabledDocs = new app.collections.Docs(doc for doc in app.docs.all() when docs.indexOf(doc.slug) is -1) |
| 57 | 55 | disabledDocs.uninstall -> |
| 58 | 56 | app.db.migrate() |
| @@ -83,9 +81,3 @@ class app.views.Settings extends app.View · 24 unmodified lines | ||
| 83 | 81 | $.stopEvent(event) |
| 84 | 82 | app.router.show '/' |
| 85 | 83 | return |
| 86 | − | |
| 87 | − onAppCacheProgress: (event) => | |
| 88 | − if event.lengthComputable | |
| 89 | − percentage = Math.round event.loaded * 100 / event.total | |
| 90 | − @saveBtn.textContent = "Downloading\u2026 (#{percentage}%)" | |
| 91 | − return | |
| @@ -30,6 +30,9 @@ class app.views.Search extends app.View · 29 unmodified lines | ||
| 30 | 30 | .on 'results', @onResults |
| 31 | 31 | .on 'end', @onEnd |
| 32 | 32 | |
| 33 | + @scope | |
| 34 | + .on 'change', @onScopeChange | |
| 35 | + | |
| 33 | 36 | app.on 'ready', @onReady |
| 34 | 37 | $.on window, 'hashchange', @searchUrl |
| 35 | 38 | $.on window, 'focus', @onWindowFocus |
| @@ -138,6 +141,11 @@ class app.views.Search extends app.View · 102 unmodified lines | ||
| 138 | 141 | $.stopEvent(event) |
| 139 | 142 | return |
| 140 | 143 | |
| 144 | + onScopeChange: => | |
| 145 | + @value = '' | |
| 146 | + @onInput() | |
| 147 | + return | |
| 148 | + | |
| 141 | 149 | afterRoute: (name, context) => |
| 142 | 150 | return if app.shortcuts.eventInProgress?.name is 'escape' |
| 143 | 151 | @reset(true) if not context.init and app.router.isIndex() |
| @@ -6,7 +6,9 @@ class app.views.SearchScope extends app.View · 5 unmodified lines | ||
| 6 | 6 | tag: '._search-tag' |
| 7 | 7 | |
| 8 | 8 | @events: |
| 9 | + click: 'onClick' | |
| 9 | 10 | keydown: 'onKeydown' |
| 11 | + textInput: 'onTextInput' | |
| 10 | 12 | |
| 11 | 13 | @routes: |
| 12 | 14 | after: 'afterRoute' |
| @@ -87,17 +89,33 @@ class app.views.SearchScope extends app.View · 74 unmodified lines | ||
| 87 | 89 | @trigger 'change', null, previousDoc |
| 88 | 90 | return |
| 89 | 91 | |
| 92 | + doScopeSearch: (event) => | |
| 93 | + @search @input.value[0...@input.selectionStart] | |
| 94 | + $.stopEvent(event) if @doc | |
| 95 | + return | |
| 96 | + | |
| 97 | + onClick: (event) => | |
| 98 | + if event.target is @tag | |
| 99 | + @reset() | |
| 100 | + $.stopEvent(event) | |
| 101 | + return | |
| 102 | + | |
| 90 | 103 | onKeydown: (event) => |
| 91 | 104 | if event.which is 8 # backspace |
| 92 | − if @doc and not @input.value | |
| 93 | − $.stopEvent(event) | |
| 105 | + if @doc and @input.selectionEnd is 0 | |
| 94 | 106 | @reset() |
| 95 | − else if not @doc and @input.value | |
| 107 | + $.stopEvent(event) | |
| 108 | + else if not @doc and @input.value and not $.isChromeForAndroid() | |
| 96 | 109 | return if event.ctrlKey or event.metaKey or event.altKey or event.shiftKey |
| 97 | 110 | if event.which is 9 or # tab |
| 98 | 111 | (event.which is 32 and app.isMobile()) # space |
| 99 | − @search @input.value[0...@input.selectionStart] | |
| 100 | − $.stopEvent(event) if @doc | |
| 112 | + @doScopeSearch(event) | |
| 113 | + return | |
| 114 | + | |
| 115 | + onTextInput: (event) => | |
| 116 | + return unless $.isChromeForAndroid() | |
| 117 | + if not @doc and @input.value and event.data == ' ' | |
| 118 | + @doScopeSearch(event) | |
| 101 | 119 | return |
| 102 | 120 | |
| 103 | 121 | extractHashValue: -> |
| @@ -28,7 +28,7 @@ class app.views.Sidebar extends app.View · 27 unmodified lines | ||
| 28 | 28 | |
| 29 | 29 | app.on 'ready', @onReady |
| 30 | 30 | |
| 31 | − $.on document.documentElement, 'mouseleave', (event) => @display() if event.clientX < 10 | |
| 31 | + $.on document.documentElement, 'mouseleave', (event) => @display() unless event.clientX <= 0 | |
| 32 | 32 | $.on document.documentElement, 'mouseenter', => @resetDisplay(forceNoHover: false) |
| 33 | 33 | return |
| 34 | 34 | |
| @@ -1,10 +1,9 @@ | ||
| 1 | −//= depend_on docs-1.png | |
| 2 | −//= depend_on docs-1@2x.png | |
| 3 | −//= depend_on docs-2.png | |
| 4 | −//= depend_on docs-2@2x.png | |
| 1 | +//= depend_on sprites/docs.png | |
| 2 | +//= depend_on sprites/docs@2x.png | |
| 3 | +//= depend_on sprites/docs.json | |
| 5 | 4 | |
| 6 | 5 | /*! |
| 7 | − * Copyright 2013-2018 Thibaut Courouble and other contributors | |
| 6 | + * Copyright 2013-2019 Thibaut Courouble and other contributors | |
| 8 | 7 | * |
| 9 | 8 | * This source code is licensed under the terms of the Mozilla |
| 10 | 9 | * Public License, v. 2.0, a copy of which may be obtained at: |
| @@ -46,6 +45,7 @@ · 35 unmodified lines | ||
| 46 | 45 | 'pages/coffeescript', |
| 47 | 46 | 'pages/cordova', |
| 48 | 47 | 'pages/crystal', |
| 48 | + 'pages/cypress', | |
| 49 | 49 | 'pages/d', |
| 50 | 50 | 'pages/d3', |
| 51 | 51 | 'pages/dart', |
| @@ -94,6 +94,7 @@ · 42 unmodified lines | ||
| 94 | 94 | 'pages/rfc', |
| 95 | 95 | 'pages/rubydoc', |
| 96 | 96 | 'pages/rust', |
| 97 | + 'pages/scala', | |
| 97 | 98 | 'pages/sinon', |
| 98 | 99 | 'pages/socketio', |
| 99 | 100 | 'pages/sphinx', |
| @@ -106,5 +107,6 @@ · 6 unmodified lines | ||
| 106 | 107 | 'pages/underscore', |
| 107 | 108 | 'pages/vue', |
| 108 | 109 | 'pages/webpack', |
| 110 | + 'pages/wordpress', | |
| 109 | 111 | 'pages/yard', |
| 110 | 112 | 'pages/yii'; |
| @@ -32,5 +32,3 @@ · 31 unmodified lines | ||
| 32 | 32 | } |
| 33 | 33 | |
| 34 | 34 | ._fail-text:last-child { margin: 0; } |
| 35 | − | |
| 36 | −._fail-link { float: right; } | |
| @@ -215,5 +215,6 @@ · 214 unmodified lines | ||
| 215 | 215 | color: var(--textColorLight); |
| 216 | 216 | background: var(--searchTagBackground); |
| 217 | 217 | border-radius: 2px; |
| 218 | + cursor: pointer; | |
| 218 | 219 | @extend %truncate-text; |
| 219 | 220 | } |
| @@ -134,3 +134,7 @@ · 133 unmodified lines | ||
| 134 | 134 | |
| 135 | 135 | ._notif-info { color: var(--textColorLight); } |
| 136 | 136 | } |
| 137 | + | |
| 138 | +._notif-right { | |
| 139 | + float: right; | |
| 140 | +} | |
| @@ -1,182 +0,0 @@ | ||
| 1 | −%svg-icon { | |
| 2 | − display: inline-block; | |
| 3 | − vertical-align: top; | |
| 4 | − width: 1rem; | |
| 5 | − height: 1rem; | |
| 6 | − pointer-events: none; | |
| 7 | − fill: currentColor; | |
| 8 | −} | |
| 9 | − | |
| 10 | −%doc-icon { | |
| 11 | − content: ''; | |
| 12 | − display: block; | |
| 13 | − width: 1rem; | |
| 14 | − height: 1rem; | |
| 15 | − background-image: image-url('docs-1.png'); | |
| 16 | − background-size: 10rem 10rem; | |
| 17 | −} | |
| 18 | − | |
| 19 | −%doc-icon-2 { background-image: image-url('docs-2.png') !important; } | |
| 20 | − | |
| 21 | −@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { | |
| 22 | − %doc-icon { background-image: image-url('docs-1@2x.png'); } | |
| 23 | − %doc-icon-2 { background-image: image-url('docs-2@2x.png') !important; } | |
| 24 | −} | |
| 25 | − | |
| 26 | −html._theme-dark { | |
| 27 | − %darkIconFix { | |
| 28 | − filter: invert(100%) grayscale(100%); | |
| 29 | − -webkit-filter: invert(100%) grayscale(100%); | |
| 30 | − } | |
| 31 | −} | |
| 32 | − | |
| 33 | −._icon-jest:before { background-position: 0 0; } | |
| 34 | −._icon-liquid:before { background-position: -1rem 0; } | |
| 35 | −._icon-openjdk:before { background-position: -2rem 0; } | |
| 36 | −._icon-codeceptjs:before { background-position: -3rem 0; } | |
| 37 | −._icon-codeception:before { background-position: -4rem 0; } | |
| 38 | −._icon-sqlite:before { background-position: -5rem 0; @extend %darkIconFix !optional; } | |
| 39 | −._icon-async:before { background-position: -6rem 0; @extend %darkIconFix !optional; } | |
| 40 | −._icon-http:before { background-position: -7rem 0; @extend %darkIconFix !optional; } | |
| 41 | −._icon-jquery:before { background-position: -8rem 0; @extend %darkIconFix !optional; } | |
| 42 | −._icon-underscore:before { background-position: -9rem 0; @extend %darkIconFix !optional; } | |
| 43 | −._icon-html:before { background-position: 0 -1rem; } | |
| 44 | −._icon-css:before { background-position: -1rem -1rem; } | |
| 45 | −._icon-dom:before { background-position: -2rem -1rem; } | |
| 46 | −._icon-dom_events:before { background-position: -3rem -1rem; } | |
| 47 | −._icon-javascript:before { background-position: -4rem -1rem; } | |
| 48 | −._icon-backbone:before { background-position: -5rem -1rem; @extend %darkIconFix !optional; } | |
| 49 | −._icon-node:before, | |
| 50 | −._icon-node_lts:before { background-position: -6rem -1rem; } | |
| 51 | −._icon-sass:before { background-position: -7rem -1rem; } | |
| 52 | −._icon-less:before { background-position: -8rem -1rem; } | |
| 53 | −._icon-angularjs:before { background-position: -9rem -1rem; } | |
| 54 | −._icon-coffeescript:before { background-position: 0 -2rem; @extend %darkIconFix !optional; } | |
| 55 | −._icon-ember:before { background-position: -1rem -2rem; } | |
| 56 | −._icon-yarn:before { background-position: -2rem -2rem; } | |
| 57 | −._icon-immutable:before { background-position: -3rem -2rem; @extend %darkIconFix !optional; } | |
| 58 | −._icon-jqueryui:before { background-position: -4rem -2rem; } | |
| 59 | −._icon-jquerymobile:before { background-position: -5rem -2rem; } | |
| 60 | −._icon-lodash:before { background-position: -6rem -2rem; } | |
| 61 | −._icon-php:before { background-position: -7rem -2rem; } | |
| 62 | −._icon-ruby:before, | |
| 63 | −._icon-minitest:before { background-position: -8rem -2rem; } | |
| 64 | −._icon-rails:before { background-position: -9rem -2rem; } | |
| 65 | −._icon-python:before, | |
| 66 | −._icon-python2:before { background-position: 0 -3rem; } | |
| 67 | −._icon-git:before { background-position: -1rem -3rem; } | |
| 68 | −._icon-redis:before { background-position: -2rem -3rem; } | |
| 69 | −._icon-postgresql:before { background-position: -3rem -3rem; } | |
| 70 | −._icon-d3:before { background-position: -4rem -3rem; } | |
| 71 | −._icon-knockout:before { background-position: -5rem -3rem; } | |
| 72 | −._icon-moment:before { background-position: -6rem -3rem; @extend %darkIconFix !optional; } | |
| 73 | −._icon-c:before { background-position: -7rem -3rem; } | |
| 74 | −._icon-statsmodels:before { background-position: -8rem -3rem; } | |
| 75 | −._icon-yii:before, | |
| 76 | −._icon-yii1:before { background-position: -9rem -3rem; } | |
| 77 | −._icon-cpp:before { background-position: 0 -4rem; } | |
| 78 | −._icon-go:before { background-position: -1rem -4rem; } | |
| 79 | −._icon-express:before { background-position: -2rem -4rem; } | |
| 80 | −._icon-grunt:before { background-position: -3rem -4rem; } | |
| 81 | −._icon-rust:before { background-position: -4rem -4rem; @extend %darkIconFix !optional; } | |
| 82 | −._icon-laravel:before { background-position: -5rem -4rem; } | |
| 83 | −._icon-haskell:before { background-position: -6rem -4rem; } | |
| 84 | −._icon-requirejs:before { background-position: -7rem -4rem; } | |
| 85 | −._icon-chai:before { background-position: -8rem -4rem; } | |
| 86 | −._icon-sinon:before { background-position: -9rem -4rem; } | |
| 87 | −._icon-cordova:before { background-position: 0 -5rem; } | |
| 88 | −._icon-markdown:before { background-position: -1rem -5rem; @extend %darkIconFix !optional; } | |
| 89 | −._icon-django:before { background-position: -2rem -5rem; } | |
| 90 | −._icon-xslt_xpath:before { background-position: -3rem -5rem; } | |
| 91 | −._icon-nginx:before, | |
| 92 | −._icon-nginx_lua_module:before { background-position: -4rem -5rem; } | |
| 93 | −._icon-svg:before { background-position: -5rem -5rem; } | |
| 94 | −._icon-marionette:before { background-position: -6rem -5rem; } | |
| 95 | −._icon-jsdoc:before, | |
| 96 | −._icon-koa:before, | |
| 97 | −._icon-graphite:before, | |
| 98 | −._icon-mongoose:before { background-position: -7rem -5rem; } | |
| 99 | −._icon-phpunit:before { background-position: -8rem -5rem; } | |
| 100 | −._icon-nokogiri:before { background-position: -9rem -5rem; @extend %darkIconFix !optional; } | |
| 101 | −._icon-rethinkdb:before { background-position: 0 -6rem; } | |
| 102 | −._icon-react:before { background-position: -1rem -6rem; } | |
| 103 | −._icon-socketio:before { background-position: -2rem -6rem; } | |
| 104 | −._icon-modernizr:before { background-position: -3rem -6rem; } | |
| 105 | −._icon-bower:before { background-position: -4rem -6rem; } | |
| 106 | −._icon-fish:before { background-position: -5rem -6rem; @extend %darkIconFix !optional; } | |
| 107 | −._icon-scikit_image:before { background-position: -6rem -6rem; } | |
| 108 | −._icon-twig:before { background-position: -7rem -6rem; } | |
| 109 | −._icon-pandas:before { background-position: -8rem -6rem; } | |
| 110 | −._icon-scikit_learn:before { background-position: -9rem -6rem; } | |
| 111 | −._icon-bottle:before { background-position: 0 -7rem; } | |
| 112 | −._icon-docker:before { background-position: -1rem -7rem; } | |
| 113 | −._icon-cakephp:before { background-position: -2rem -7rem; } | |
| 114 | −._icon-lua:before { background-position: -3rem -7rem; @extend %darkIconFix !optional; } | |
| 115 | −._icon-clojure:before { background-position: -4rem -7rem; } | |
| 116 | −._icon-symfony:before { background-position: -5rem -7rem; } | |
| 117 | −._icon-mocha:before { background-position: -6rem -7rem; } | |
| 118 | −._icon-meteor:before { background-position: -7rem -7rem; @extend %darkIconFix !optional; } | |
| 119 | −._icon-npm:before { background-position: -8rem -7rem; } | |
| 120 | −._icon-apache_http_server:before { background-position: -9rem -7rem; } | |
| 121 | −._icon-drupal:before { background-position: 0 -8rem; } | |
| 122 | −._icon-webpack:before { background-position: -1rem -8rem; } | |
| 123 | −._icon-phaser:before { background-position: -2rem -8rem; } | |
| 124 | −._icon-vue:before { background-position: -3rem -8rem; } | |
| 125 | −._icon-opentsdb:before { background-position: -4rem -8rem; } | |
| 126 | −._icon-q:before { background-position: -5rem -8rem; } | |
| 127 | −._icon-crystal:before { background-position: -6rem -8rem; @extend %darkIconFix !optional; } | |
| 128 | −._icon-julia:before { background-position: -7rem -8rem; @extend %darkIconFix !optional; } | |
| 129 | −._icon-redux:before { background-position: -8rem -8rem; @extend %darkIconFix !optional; } | |
| 130 | −._icon-bootstrap:before { background-position: -9rem -8rem; } | |
| 131 | −._icon-react_native:before { background-position: 0 -9rem; } | |
| 132 | −._icon-phalcon:before { background-position: -1rem -9rem; } | |
| 133 | −._icon-matplotlib:before { background-position: -2rem -9rem; } | |
| 134 | −._icon-cmake:before { background-position: -3rem -9rem; } | |
| 135 | −._icon-elixir:before { background-position: -4rem -9rem; @extend %darkIconFix !optional; } | |
| 136 | −._icon-vagrant:before { background-position: -5rem -9rem; } | |
| 137 | −._icon-dojo:before { background-position: -6rem -9rem; } | |
| 138 | −._icon-flow:before { background-position: -7rem -9rem; } | |
| 139 | −._icon-relay:before { background-position: -8rem -9rem; } | |
| 140 | −._icon-phoenix:before { background-position: -9rem -9rem; } | |
| 141 | − | |
| 142 | −._icon-tcl_tk:before { background-position: 0 0; @extend %doc-icon-2; } | |
| 143 | −._icon-erlang:before { background-position: -1rem 0; @extend %doc-icon-2; } | |
| 144 | −._icon-chef:before { background-position: -2rem 0; @extend %doc-icon-2; } | |
| 145 | −._icon-ramda:before { background-position: -3rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 146 | −._icon-codeigniter:before { background-position: -4rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 147 | −._icon-influxdata:before { background-position: -5rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 148 | −._icon-tensorflow:before { background-position: -6rem 0; @extend %doc-icon-2; } | |
| 149 | −._icon-haxe:before { background-position: -7rem 0; @extend %doc-icon-2; } | |
| 150 | −._icon-ansible:before { background-position: -8rem 0; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 151 | −._icon-typescript:before { background-position: -9rem 0; @extend %doc-icon-2; } | |
| 152 | −._icon-browser_support_tables:before { background-position: 0rem -1rem; @extend %doc-icon-2; } | |
| 153 | −._icon-gnu_fortran:before { background-position: -1rem -1rem; @extend %doc-icon-2; } | |
| 154 | −._icon-gcc:before { background-position: -2rem -1rem; @extend %doc-icon-2; } | |
| 155 | −._icon-perl:before { background-position: -3rem -1rem; @extend %doc-icon-2; } | |
| 156 | −._icon-apache_pig:before { background-position: -4rem -1rem; @extend %doc-icon-2; } | |
| 157 | −._icon-numpy:before { background-position: -5rem -1rem; @extend %doc-icon-2; } | |
| 158 | −._icon-kotlin:before { background-position: -6rem -1rem; @extend %doc-icon-2; } | |
| 159 | −._icon-padrino:before { background-position: -7rem -1rem; @extend %doc-icon-2; } | |
| 160 | −._icon-angular:before { background-position: -8rem -1rem; @extend %doc-icon-2; } | |
| 161 | −._icon-love:before { background-position: -9rem -1rem; @extend %doc-icon-2; } | |
| 162 | −._icon-jasmine:before { background-position: 0 -2rem; @extend %doc-icon-2; } | |
| 163 | −._icon-pug:before { background-position: -1rem -2rem; @extend %doc-icon-2; } | |
| 164 | −._icon-electron:before { background-position: -2rem -2rem; @extend %doc-icon-2; } | |
| 165 | −._icon-falcon:before { background-position: -3rem -2rem; @extend %doc-icon-2; } | |
| 166 | −._icon-godot:before { background-position: -4rem -2rem; @extend %doc-icon-2; } | |
| 167 | −._icon-nim:before { background-position: -5rem -2rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 168 | −._icon-vulkan:before { background-position: -6rem -2rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| 169 | −._icon-d:before { background-position: -7rem -2rem; @extend %doc-icon-2; } | |
| 170 | −._icon-bluebird:before { background-position: -8rem -2rem; @extend %doc-icon-2; } | |
| 171 | −._icon-eslint:before { background-position: -9rem -2rem; @extend %doc-icon-2; } | |
| 172 | −._icon-homebrew:before { background-position: 0 -3rem; @extend %doc-icon-2; } | |
| 173 | −._icon-jekyll:before { background-position: -1rem -3rem; @extend %doc-icon-2; } | |
| 174 | −._icon-babel:before { background-position: -2rem -3rem; @extend %doc-icon-2; } | |
| 175 | −._icon-leaflet:before { background-position: -3rem -3rem; @extend %doc-icon-2; } | |
| 176 | −._icon-terraform:before { background-position: -4rem -3rem; @extend %doc-icon-2; } | |
| 177 | −._icon-pygame:before { background-position: -5rem -3rem; @extend %doc-icon-2; } | |
| 178 | −._icon-bash:before { background-position: -6rem -3rem; @extend %doc-icon-2; } | |
| 179 | −._icon-dart:before { background-position: -7rem -3rem; @extend %doc-icon-2; } | |
| 180 | −._icon-qt:before { background-position: -8rem -3rem; @extend %doc-icon-2; } | |
| 181 | −._icon-puppeteer:before { background-position: -9rem -3rem; @extend %doc-icon-2; } | |
| 182 | −._icon-handlebars:before { background-position: 0 -4rem; @extend %doc-icon-2; @extend %darkIconFix !optional; } | |
| @@ -0,0 +1,43 @@ | ||
| 1 | +<% manifest = JSON.parse(File.read('assets/images/sprites/docs.json')) %> | |
| 2 | + | |
| 3 | +%svg-icon { | |
| 4 | + display: inline-block; | |
| 5 | + vertical-align: top; | |
| 6 | + width: 1rem; | |
| 7 | + height: 1rem; | |
| 8 | + pointer-events: none; | |
| 9 | + fill: currentColor; | |
| 10 | +} | |
| 11 | + | |
| 12 | +%doc-icon { | |
| 13 | + content: ''; | |
| 14 | + display: block; | |
| 15 | + width: 1rem; | |
| 16 | + height: 1rem; | |
| 17 | + background-image: image-url('sprites/docs.png'); | |
| 18 | + background-size: <%= manifest['icons_per_row'] %>rem <%= manifest['icons_per_row'] %>rem; | |
| 19 | +} | |
| 20 | + | |
| 21 | +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { | |
| 22 | + %doc-icon { background-image: image-url('sprites/docs@2x.png'); } | |
| 23 | +} | |
| 24 | + | |
| 25 | +html._theme-dark { | |
| 26 | + %darkIconFix { | |
| 27 | + filter: invert(100%) grayscale(100%); | |
| 28 | + -webkit-filter: invert(100%) grayscale(100%); | |
| 29 | + } | |
| 30 | +} | |
| 31 | + | |
| 32 | +<%= | |
| 33 | + items = [] | |
| 34 | + | |
| 35 | + manifest['items'].each do |item| | |
| 36 | + rules = [] | |
| 37 | + rules << "background-position: -#{item['col']}rem -#{item['row']}rem;" | |
| 38 | + rules << "@extend %darkIconFix !optional;" if item['dark_icon_fix'] | |
| 39 | + items << "._icon-#{item['type']}:before { #{rules.join(' ')} }" | |
| 40 | + end | |
| 41 | + | |
| 42 | + items.join('') | |
| 43 | + %> | |
| @@ -0,0 +1,21 @@ | ||
| 1 | +._cypress { | |
| 2 | + @extend %simple; | |
| 3 | + | |
| 4 | + .note { | |
| 5 | + h1 { | |
| 6 | + margin-left: inherit | |
| 7 | + } | |
| 8 | + | |
| 9 | + &.danger { | |
| 10 | + @extend %note-red | |
| 11 | + } | |
| 12 | + | |
| 13 | + &.info { | |
| 14 | + @extend %note-blue | |
| 15 | + } | |
| 16 | + | |
| 17 | + &.success { | |
| 18 | + @extend %note-green | |
| 19 | + } | |
| 20 | + } | |
| 21 | +} | |
| @@ -33,19 +33,8 @@ · 32 unmodified lines | ||
| 33 | 33 | } |
| 34 | 34 | } |
| 35 | 35 | |
| 36 | − .method-description { position: relative; } | |
| 37 | − | |
| 38 | 36 | .method-source-code { |
| 39 | 37 | display: none; |
| 40 | − position: absolute; | |
| 41 | − z-index: 1; | |
| 42 | − top: 0; | |
| 43 | − left: -1em; | |
| 44 | − right: 0; | |
| 45 | − background: var(--contentBackground); | |
| 46 | − box-shadow: 0 1em 1em 1em var(--contentBackground); | |
| 47 | − | |
| 48 | − > pre { margin: 0; } | |
| 49 | 38 | } |
| 50 | 39 | |
| 51 | 40 | // Rails guides |
| @@ -0,0 +1,4 @@ | ||
| 1 | +._scala { | |
| 2 | + @extend %simple; | |
| 3 | + .deprecated { @extend %label-red; } | |
| 4 | +} | |
| @@ -0,0 +1,15 @@ | ||
| 1 | +._wordpress { | |
| 2 | + @extend %simple; | |
| 3 | + | |
| 4 | + .breadcrumbs { | |
| 5 | + display: none; | |
| 6 | + } | |
| 7 | + | |
| 8 | + .callout-warning { | |
| 9 | + @extend %note, %note-red; | |
| 10 | + } | |
| 11 | + | |
| 12 | + .callout-alert { | |
| 13 | + @extend %note, %note-orange; | |
| 14 | + } | |
| 15 | +} | |
| @@ -0,0 +1,24 @@ | ||
| 1 | +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 [in Gitter](https://gitter.im/FreeCodeCamp/DevDocs) if you ever get stuck. | |
| 2 | + | |
| 3 | +**Note:** please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation. | |
| 4 | + | |
| 5 | +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`) | |
| 6 | +2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page). | |
| 7 | +3. Check that the scraper is listed in `thor docs:list`. | |
| 8 | +4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](./scraper-reference.md#filter-stacks). You may create any number of filters but will need at least the following two: | |
| 9 | + * A [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential. | |
| 10 | + * An [`Entries`](./filter-reference.md#entriesfilter) filter whose task is to determine the pages' metadata (the list of entries, each with a name, type and path). | |
| 11 | + The [Filter Reference](./filter-reference.md) page has all the details about filters. | |
| 12 | +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`). | |
| 13 | +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). | |
| 14 | +7. Start the server, open the app, enable the documentation, and see how everything plays out. | |
| 15 | +8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok. | |
| 16 | +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). Setting the type to `simple` will apply the general styling rules in `assets/stylesheets/pages/_simple.scss`, which can be used for documentations where little to no CSS changes are needed. | |
| 17 | +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). | |
| 18 | +11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. The icon spritesheet is automatically generated when you (re)start your local DevDocs instance. | |
| 19 | +12. Add the documentation's copyright details to the list in `assets/javascripts/templates/pages/about_tmpl.coffee`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Simply copying an existing item, placing it in the right slot and updating the values to match the new scraper will do the job. | |
| 20 | +13. Ensure `thor updates:check [my_doc]` shows the correct latest version. | |
| 21 | + | |
| 22 | +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.) | |
| 23 | + | |
| 24 | +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. | |
| @@ -0,0 +1,224 @@ | ||
| 1 | +**Table of contents:** | |
| 2 | + | |
| 3 | +* [Overview](#overview) | |
| 4 | +* [Instance methods](#instance-methods) | |
| 5 | +* [Core filters](#core-filters) | |
| 6 | +* [Custom filters](#custom-filters) | |
| 7 | + - [CleanHtmlFilter](#cleanhtmlfilter) | |
| 8 | + - [EntriesFilter](#entriesfilter) | |
| 9 | + | |
| 10 | +## Overview | |
| 11 | + | |
| 12 | +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. | |
| 13 | + | |
| 14 | +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: | |
| 15 | + | |
| 16 | +```ruby | |
| 17 | +module Docs | |
| 18 | + class CustomFilter < Filter | |
| 19 | + def call | |
| 20 | + doc | |
| 21 | + end | |
| 22 | + end | |
| 23 | +end | |
| 24 | +``` | |
| 25 | + | |
| 26 | +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](./scraper-reference.md#filter-stacks)). This is to avoid parsing the document multiple times. | |
| 27 | + | |
| 28 | +The `call` method must return either `doc` or `html`, depending on the type of filter. | |
| 29 | + | |
| 30 | +## Instance methods | |
| 31 | + | |
| 32 | +* `doc` [Nokogiri::XML::Node] | |
| 33 | + The Nokogiri representation of the container element. | |
| 34 | + See [Nokogiri's API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node) for the list of available methods. | |
| 35 | + | |
| 36 | +* `html` [String] | |
| 37 | + The string representation of the container element. | |
| 38 | + | |
| 39 | +* `context` [Hash] **(frozen)** | |
| 40 | + The scraper's `options` along with a few additional keys: `:base_url`, `:root_url`, `:root_page` and `:url`. | |
| 41 | + | |
| 42 | +* `result` [Hash] | |
| 43 | + Used to store the page's metadata and pass back information to the scraper. | |
| 44 | + Possible keys: | |
| 45 | + | |
| 46 | + - `:path` — the page's normalized path | |
| 47 | + - `:store_path` — the path where the page will be stored (equal to `:path` with `.html` at the end) | |
| 48 | + - `:internal_urls` — the list of distinct internal URLs found within the page | |
| 49 | + - `:entries` — the [`Entry`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb) objects to add to the index | |
| 50 | + | |
| 51 | +* `css`, `at_css`, `xpath`, `at_xpath` | |
| 52 | + Shortcuts for `doc.css`, `doc.xpath`, etc. | |
| 53 | + | |
| 54 | +* `base_url`, `current_url`, `root_url` [Docs::URL] | |
| 55 | + Shortcuts for `context[:base_url]`, `context[:url]`, and `context[:root_url]` respectively. | |
| 56 | + | |
| 57 | +* `root_path` [String] | |
| 58 | + Shortcut for `context[:root_path]`. | |
| 59 | + | |
| 60 | +* `subpath` [String] | |
| 61 | + The sub-path from the base URL of the current URL. | |
| 62 | + _Example: if `base_url` equals `example.com/docs` and `current_url` equals `example.com/docs/file?raw`, the returned value is `/file`._ | |
| 63 | + | |
| 64 | +* `slug` [String] | |
| 65 | + The `subpath` removed of any leading slash or `.html` extension. | |
| 66 | + _Example: if `subpath` equals `/dir/file.html`, the returned value is `dir/file`._ | |
| 67 | + | |
| 68 | +* `root_page?` [Boolean] | |
| 69 | + Returns `true` if the current page is the root page. | |
| 70 | + | |
| 71 | +* `initial_page?` [Boolean] | |
| 72 | + Returns `true` if the current page is the root page or its subpath is one of the scraper's `initial_paths`. | |
| 73 | + | |
| 74 | +## Core filters | |
| 75 | + | |
| 76 | +* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside) | |
| 77 | +* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc. | |
| 78 | +* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart | |
| 79 | +* [`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 | |
| 80 | +* [`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`) | |
| 81 | +* [`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) | |
| 82 | +* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string | |
| 83 | +* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes | |
| 84 | +* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document | |
| 85 | +* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) — prepends the document with a title (disabled by default) | |
| 86 | +* [`EntriesFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/entries.rb) — abstract filter for extracting the page's metadata | |
| 87 | + | |
| 88 | +## Custom filters | |
| 89 | + | |
| 90 | +Scrapers can have any number of custom filters but require at least the two described below. | |
| 91 | + | |
| 92 | +**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. | |
| 93 | + | |
| 94 | +### `CleanHtmlFilter` | |
| 95 | + | |
| 96 | +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. | |
| 97 | + | |
| 98 | +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). | |
| 99 | + | |
| 100 | +Here's an example implementation that covers the most common use-cases: | |
| 101 | + | |
| 102 | +```ruby | |
| 103 | +module Docs | |
| 104 | + class MyScraper | |
| 105 | + class CleanHtmlFilter < Filter | |
| 106 | + def call | |
| 107 | + css('hr').remove | |
| 108 | + css('#changelog').remove if root_page? | |
| 109 | + | |
| 110 | + # Set id attributes on <h3> instead of an empty <a> | |
| 111 | + css('h3').each do |node| | |
| 112 | + node['id'] = node.at_css('a')['id'] | |
| 113 | + end | |
| 114 | + | |
| 115 | + # Make proper table headers | |
| 116 | + css('td.header').each do |node| | |
| 117 | + node.name = 'th' | |
| 118 | + end | |
| 119 | + | |
| 120 | + # Remove code highlighting | |
| 121 | + css('pre').each do |node| | |
| 122 | + node.content = node.content | |
| 123 | + end | |
| 124 | + | |
| 125 | + doc | |
| 126 | + end | |
| 127 | + end | |
| 128 | + end | |
| 129 | +end | |
| 130 | +``` | |
| 131 | + | |
| 132 | +**Notes:** | |
| 133 | + | |
| 134 | +* Empty elements will be automatically removed by the core `CleanTextFilter` later in the pipeline's execution. | |
| 135 | +* 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). | |
| 136 | +* 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. | |
| 137 | + | |
| 138 | +### `EntriesFilter` | |
| 139 | + | |
| 140 | +The `Entries` filter is responsible for extracting the page's metadata, represented by a set of _entries_, each with a name, type and path. | |
| 141 | + | |
| 142 | +The following two models are used under the hood to represent the metadata: | |
| 143 | + | |
| 144 | +* [`Entry(name, type, path)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/entry.rb) | |
| 145 | +* [`Type(name, slug, count)`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/core/models/type.rb) | |
| 146 | + | |
| 147 | +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: | |
| 148 | + | |
| 149 | +* `get_name` [String] | |
| 150 | + The name of the default entry (aka. the page's name). | |
| 151 | + It is usually guessed from the `slug` (documented above) or by searching the HTML markup. | |
| 152 | + **Default:** modified version of `slug` (underscores are replaced with spaces and forward slashes with dots) | |
| 153 | + | |
| 154 | +* `get_type` [String] | |
| 155 | + The type of the default entry (aka. the page's type). | |
| 156 | + 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). | |
| 157 | + **Default:** `nil` | |
| 158 | + | |
| 159 | +* `include_default_entry?` [Boolean] | |
| 160 | + Whether to include the default entry. | |
| 161 | + 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](./scraper-reference.md) 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). | |
| 162 | + **Default:** `true` | |
| 163 | + | |
| 164 | +* `additional_entries` [Array] | |
| 165 | + The list of additional entries. | |
| 166 | + 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. | |
| 167 | + 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". | |
| 168 | + The list is usually constructed by running through the markup. Exceptions can also be hard-coded for specific pages. | |
| 169 | + **Default:** `[]` | |
| 170 | + | |
| 171 | +The following accessors are also available, but must not be overridden: | |
| 172 | + | |
| 173 | +* `name` [String] | |
| 174 | + Memoized version of `get_name` (`nil` for the root page). | |
| 175 | + | |
| 176 | +* `type` [String] | |
| 177 | + Memoized version of `get_type` (`nil` for the root page). | |
| 178 | + | |
| 179 | +**Notes:** | |
| 180 | + | |
| 181 | +* Leading and trailing whitespace is automatically removed from names and types. | |
| 182 | +* 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. | |
| 183 | +* 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. | |
| 184 | +* 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). | |
| 185 | +* `Docs::EntriesFilter` is an _HTML filter_. It must be added to the scraper's `html_filters` stack. | |
| 186 | +* Try to document the code as much as possible, particularly the special cases. It'll make updating the documentation easier. | |
| 187 | + | |
| 188 | +**Example:** | |
| 189 | + | |
| 190 | +```ruby | |
| 191 | +module Docs | |
| 192 | + class MyScraper | |
| 193 | + class EntriesFilter < Docs::EntriesFilter | |
| 194 | + def get_name | |
| 195 | + node = at_css('h1') | |
| 196 | + result = node.content.strip | |
| 197 | + result << ' event' if type == 'Events' | |
| 198 | + result << '()' if node['class'].try(:include?, 'function') | |
| 199 | + result | |
| 200 | + end | |
| 201 | + | |
| 202 | + def get_type | |
| 203 | + object, method = *slug.split('/') | |
| 204 | + method ? object : 'Miscellaneous' | |
| 205 | + end | |
| 206 | + | |
| 207 | + def additional_entries | |
| 208 | + return [] if root_page? | |
| 209 | + | |
| 210 | + css('h2').map do |node| | |
| 211 | + [node.content, node['id']] | |
| 212 | + end | |
| 213 | + end | |
| 214 | + | |
| 215 | + def include_default_entry? | |
| 216 | + !at_css('.obsolete') | |
| 217 | + end | |
| 218 | + end | |
| 219 | + end | |
| 220 | +end | |
| 221 | +``` | |
| 222 | + | |
| 223 | + | |
| 224 | +return [[Home]] | |
| @@ -0,0 +1,102 @@ | ||
| 1 | +# Maintainer's Guide | |
| 2 | + | |
| 3 | +This document is intended for [DevDocs maintainers](#list-of-maintainers). | |
| 4 | + | |
| 5 | +## Merging pull requests | |
| 6 | + | |
| 7 | +- PRs should be approved by at least one maintainer before being merged. | |
| 8 | + | |
| 9 | +- PRs that add or update documentations should always be merged locally, and the app deployed, before the merge is pushed to GitHub. | |
| 10 | + | |
| 11 | + This workflow is required because there is a dependency between the local and production environments. The `thor docs:download` command downloads documentations from production files uploaded by the `thor docs:upload` command. If a PR adding a new documentation is merged and pushed to GitHub before the files have been uploaded to production, the `thor docs:download` will fail for the new documentation and the docker container will not build properly until the new documentation is deployed to production. | |
| 12 | + | |
| 13 | +## Updating docs | |
| 14 | + | |
| 15 | +The process for updating docs is as follow: | |
| 16 | + | |
| 17 | +- Make version/release changes in the scraper file. | |
| 18 | +- If needed, update the copyright notice of the documentation in the scraper file (`options[:attribution]`) and the about page (`about_tmpl.coffee`). The copyright notice must be the same as the one on the original documentation. | |
| 19 | +- Run `thor docs:generate`. | |
| 20 | +- Make sure the documentation still works well. The `thor docs:generate` command outputs a summary of the changes, which helps identifying issues (e.g. deleted files) and new pages to check out in the app. Verify locally that everything works, especially the files that were created (if any), and that the categorization of entries is still good. Often, updates will require code changes to tweak some new markup in the source website or categorize new entries. | |
| 21 | +- Commit the changes (protip: use the `thor docs:commit` command documented below). | |
| 22 | +- Optional: do more updates. | |
| 23 | +- Run `thor docs:upload` (documented below). | |
| 24 | +- Push to GitHub to [deploy the app](#deploying-devdocs) and verify that everything works in production. | |
| 25 | +- Run `thor docs:clean` (documented below). | |
| 26 | + | |
| 27 | +Note: changes to `public/docs/docs.json` should never be committed. This file reflects which documentations have been downloaded or generated locally, which is always none on a fresh `git clone`. | |
| 28 | + | |
| 29 | +## Setup requirements | |
| 30 | + | |
| 31 | +In order to deploy DevDocs, you must: | |
| 32 | + | |
| 33 | +- be given access to Heroku, [configure the Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) on your computer, and familiarize yourself with Heroku's UI and CLI, as well as that of New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)). | |
| 34 | + | |
| 35 | +- be given access to DevDocs's [Sentry instance](https://sentry.io/devdocs/devdocs-js/) (for JS error tracking) and familiarize yourself with its UI. | |
| 36 | + | |
| 37 | +- be provided with DevDocs's S3 credentials, and install (`brew install awscli` on macOS) and [configure](https://docs.aws.amazon.com/cli/latest/reference/configure/) the AWS CLI on your computer. The configuration must add a named profile called "devdocs": | |
| 38 | + ``` | |
| 39 | + aws configure --profile devdocs | |
| 40 | + ``` | |
| 41 | + | |
| 42 | +- be provided with DevDocs's MaxCDN push zone credentials, and add them to your `.bash_profile` as such: | |
| 43 | + ``` | |
| 44 | + export DEVDOCS_DL_USERNAME="username" | |
| 45 | + export DEVDOCS_DL_PASSWORD="password" | |
| 46 | + ``` | |
| 47 | + | |
| 48 | +## Thor commands | |
| 49 | + | |
| 50 | +In addition to the [publicly-documented commands](https://github.com/freeCodeCamp/devdocs#available-commands), the following commands are aimed at DevDocs maintainers: | |
| 51 | + | |
| 52 | +- `thor docs:package` | |
| 53 | + | |
| 54 | + Generates packages for one or more documentations. Those packages are intended to be uploaded to DevDocs's MaxCDN push zone by maintainers via the `thor docs:upload` command, and downloaded by users via the `thor docs:download` command. | |
| 55 | + | |
| 56 | + Versions can be specified as such: `thor docs:package rails@5.2 node@10\ LTS`. | |
| 57 | + | |
| 58 | + Packages can also be automatically generated during the scraping process by passing the `--package` option to `thor docs:generate`. | |
| 59 | + | |
| 60 | +- `thor docs:upload` | |
| 61 | + | |
| 62 | + This command does two operations: | |
| 63 | + | |
| 64 | + 1. sync the files for the specified documentations with S3 (used by the Heroku app); | |
| 65 | + 2. upload the documentations' packages to DevDocs's MaxCDN push zone (used by the `thor docs:download` command). | |
| 66 | + | |
| 67 | + For the command to work, you must have the AWS CLI and MaxCDN credentials configured as indicated above. | |
| 68 | + | |
| 69 | + **Important:** the app should always be deployed immediately after this command has finished running. Do not run this command unless you are able and ready to deploy DevDocs. | |
| 70 | + | |
| 71 | + To upload all documentations that are packaged on your computer, run `thor docs:upload --packaged`. | |
| 72 | + To test your configuration and the effect of this command without uploading anything, pass the `--dryrun` option. | |
| 73 | + | |
| 74 | +- `thor docs:commit` | |
| 75 | + | |
| 76 | + Shortcut command to create a Git commit for a given documentation once it has been updated. Scraper and `assets/` file changes will be committed. The commit message will include the most recent version that the documentation was updated to. If some files were missed by the commit, use `git commit --amend` to add them to the commit. The command may be run before `thor docs:upload` is run, but the commit should not be pushed to GitHub before the files have been uploaded and the app deployed. | |
| 77 | + | |
| 78 | +- `thor docs:clean` | |
| 79 | + | |
| 80 | + Shortcut command to delete all package files (once uploaded via `thor docs:upload`, they are not needed anymore). | |
| 81 | + | |
| 82 | +## Deploying DevDocs | |
| 83 | + | |
| 84 | +Once docs have been uploaded via `thor docs:upload` (if applicable), you can push to the DevDocs master branch (or merge the PR containing the updates). If the Travis build succeeds, the Heroku application will be deployed automatically. | |
| 85 | + | |
| 86 | +- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done. Keep in mind that you'll need to wait a few seconds for the service worker to finish caching the new assets. You should see a "DevDocs has been updated" notification appear when the caching is done, after which you need to refresh the page to see the changes. | |
| 87 | +- If you're deploying frontend changes, monitor [Sentry](https://sentry.io/devdocs/devdocs-js/) for new JS errors once the deploy is done. | |
| 88 | +- If you're deploying server changes, monitor New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)) for Ruby exceptions and throughput or response time changes once the deploy is done. | |
| 89 | + | |
| 90 | +If any issue arises, run `heroku rollback` to rollback to the previous version of the app (this can also be done via Heroku's UI). Note that this will not revert changes made to documentation files that were uploaded via `thor docs:upload`. Try and fix the issue as quickly as possible, then re-deploy the app. Reach out to other maintainers if you need help. | |
| 91 | + | |
| 92 | +If this is your first deploy, make sure another maintainer is around to assist. | |
| 93 | + | |
| 94 | +## List of maintainers | |
| 95 | + | |
| 96 | +- [Jed Fox](https://github.com/j-f1) | |
| 97 | +- [Jasper van Merle](https://github.com/jmerle) | |
| 98 | +- [Ahmad Abdolsaheb](https://github.com/ahmadabdolsaheb) | |
| 99 | +- [Mrugesh Mohapatra](https://github.com/raisedadead) | |
| 100 | +- [Thibaut Courouble](https://github.com/thibaut) | |
| 101 | + | |
| 102 | +Interested in helping maintain DevDocs? Come talk to us on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs) :) | |
| @@ -0,0 +1,227 @@ | ||
| 1 | +**Table of contents:** | |
| 2 | + | |
| 3 | +* [Overview](#overview) | |
| 4 | +* [Configuration](#configuration) | |
| 5 | + - [Attributes](#attributes) | |
| 6 | + - [Filter stacks](#filter-stacks) | |
| 7 | + - [Filter options](#filter-options) | |
| 8 | + | |
| 9 | +## Overview | |
| 10 | + | |
| 11 | +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. | |
| 12 | + | |
| 13 | +Scrapers rely on the following libraries: | |
| 14 | + | |
| 15 | +* [Typhoeus](https://github.com/typhoeus/typhoeus) for making HTTP requests | |
| 16 | +* [HTML::Pipeline](https://github.com/jch/html-pipeline) for applying filters | |
| 17 | +* [Nokogiri](http://nokogiri.org/) for parsing HTML | |
| 18 | + | |
| 19 | +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. | |
| 20 | + | |
| 21 | +To be processed, a response must meet the following requirements: | |
| 22 | + | |
| 23 | +* 200 status code | |
| 24 | +* HTML content type | |
| 25 | +* effective URL (after redirection) contained in the base URL (explained below) | |
| 26 | + | |
| 27 | +(`FileScraper` only checks if the file exists and is not empty.) | |
| 28 | + | |
| 29 | +Each URL is requested only once (case-insensitive). | |
| 30 | + | |
| 31 | +## Configuration | |
| 32 | + | |
| 33 | +Configuration is done via class attributes and divided into three main categories: | |
| 34 | + | |
| 35 | +* [Attributes](#attributes) — essential information such as name, version, URL, etc. | |
| 36 | +* [Filter stacks](#filter-stacks) — the list of filters that will be applied to each page. | |
| 37 | +* [Filter options](#filter-options) — the options passed to said filters. | |
| 38 | + | |
| 39 | +**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. | |
| 40 | + | |
| 41 | +### Attributes | |
| 42 | + | |
| 43 | +* `name` [String] | |
| 44 | + Must be unique. | |
| 45 | + Defaults to the class's name. | |
| 46 | + | |
| 47 | +* `slug` [String] | |
| 48 | + Must be unique, lowercase, and not include dashes (underscores are ok). | |
| 49 | + Defaults to `name` lowercased. | |
| 50 | + | |
| 51 | +* `type` [String] **(required, inherited)** | |
| 52 | + 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. | |
| 53 | + Must include lowercase letters only. | |
| 54 | + | |
| 55 | +* `release` [String] **(required)** | |
| 56 | + 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. | |
| 57 | + | |
| 58 | +* `base_url` [String] **(required in `UrlScraper`)** | |
| 59 | + 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). | |
| 60 | + 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.)_ | |
| 61 | + Unless `root_path` is set, the root/initial URL is equal to `base_url`. | |
| 62 | + | |
| 63 | +* `root_path` [String] **(inherited)** | |
| 64 | + The path from the `base_url` of the root URL. | |
| 65 | + | |
| 66 | +* `initial_paths` [Array] **(inherited)** | |
| 67 | + A list of paths (from the `base_url`) to add to the initial queue. Useful for scraping isolated documents. | |
| 68 | + Defaults to `[]`. _(Note: the `root_path` is added to the array at runtime.)_ | |
| 69 | + | |
| 70 | +* `dir` [String] **(required, `FileScraper` only)** | |
| 71 | + The absolute path where the files are located on the local filesystem. | |
| 72 | + _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._ | |
| 73 | + | |
| 74 | +* `params` [Hash] **(inherited, `UrlScraper` only)** | |
| 75 | + Query string parameters to append to every URL. (e.g. `{ format: 'raw' }` → `?format=raw`) | |
| 76 | + Defaults to `{}`. | |
| 77 | + | |
| 78 | +* `abstract` [Boolean] | |
| 79 | + 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). | |
| 80 | + Defaults to `false`. | |
| 81 | + | |
| 82 | +### Filter stacks | |
| 83 | + | |
| 84 | +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. | |
| 85 | + | |
| 86 | +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. | |
| 87 | + | |
| 88 | +Filter stacks are like sorted sets. They can modified using the following methods: | |
| 89 | + | |
| 90 | +```ruby | |
| 91 | +push(*names) # append one or more filters at the end | |
| 92 | +insert_before(index, *names) # insert one filter before another (index can be a name) | |
| 93 | +insert_after(index, *names) # insert one filter after another (index can be a name) | |
| 94 | +replace(index, name) # replace one filter with another (index can be a name) | |
| 95 | +``` | |
| 96 | + | |
| 97 | +"names" are `require` paths relative to `Docs` (e.g. `jquery/clean_html` → `Docs::Jquery::CleanHtml`). | |
| 98 | + | |
| 99 | +Default `html_filters`: | |
| 100 | + | |
| 101 | +* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) — changes the root node of the document (remove everything outside) | |
| 102 | +* [`CleanHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_html.rb) — removes HTML comments, `<script>`, `<style>`, etc. | |
| 103 | +* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) — replaces all URLs with their fully qualified counterpart | |
| 104 | +* [`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 | |
| 105 | +* [`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`) | |
| 106 | +* [`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) | |
| 107 | + | |
| 108 | +Default `text_filters`: | |
| 109 | + | |
| 110 | +* [`InnerHtmlFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/inner_html.rb) — converts the document to a string | |
| 111 | +* [`CleanTextFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/clean_text.rb) — removes empty nodes | |
| 112 | +* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) — appends the license info and link to the original document | |
| 113 | + | |
| 114 | +Additionally: | |
| 115 | + | |
| 116 | +* [`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>`). | |
| 117 | +* [`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. | |
| 118 | + | |
| 119 | +### Filter options | |
| 120 | + | |
| 121 | +The filter options are stored in the `options` Hash. The Hash is inheritable (a recursive copy) and empty by default. | |
| 122 | + | |
| 123 | +More information about how filters work is available on the [Filter Reference](./filter-reference.md) page. | |
| 124 | + | |
| 125 | +* [`ContainerFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/container.rb) | |
| 126 | + | |
| 127 | + - `:container` [String or Proc] | |
| 128 | + 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. | |
| 129 | + 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`. | |
| 130 | + The default container is the `<body>` element. | |
| 131 | + _Note: links outside of the container element will not be followed by the scraper. To remove links that should be followed, use a [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter later in the stack._ | |
| 132 | + | |
| 133 | +* [`NormalizeUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/normalize_urls.rb) | |
| 134 | + 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). | |
| 135 | + | |
| 136 | + - `:replace_urls` [Hash] | |
| 137 | + Replaces all instances of a URL with another. | |
| 138 | + Format: `{ 'original_url' => 'new_url' }` | |
| 139 | + - `:replace_paths` [Hash] | |
| 140 | + Replaces all instances of a sub-path (path from the `base_url`) with another. | |
| 141 | + Format: `{ 'original_path' => 'new_path' }` | |
| 142 | + - `:fix_urls` [Proc] | |
| 143 | + Called with each URL. If the returned value is `nil`, the URL isn't modified. Otherwise the returned value is used as replacement. | |
| 144 | + | |
| 145 | + _Note: before these rules are applied, all URLs are converted to their fully qualified counterpart (http://...)._ | |
| 146 | + | |
| 147 | +* [`InternalUrlsFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/internal_urls.rb) | |
| 148 | + | |
| 149 | + 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. | |
| 150 | + | |
| 151 | + - `:skip_links` [Boolean or Proc] | |
| 152 | + If `false`, does not convert or follow any internal URL (creating a single-page documentation). | |
| 153 | + If the value is a Proc, it is called for each page with the filter instance as argument. | |
| 154 | + - `:follow_links` [Proc] | |
| 155 | + Called for page with the filter instance as argument. If the returned value is `false`, does not add internal URLs to the queue. | |
| 156 | + - `:trailing_slash` [Boolean] | |
| 157 | + If `true`, adds a trailing slash to all internal URLs. If `false`, removes it. | |
| 158 | + This is another option used to remove duplicate pages. | |
| 159 | + - `:skip` [Array] | |
| 160 | + Ignores internal URLs whose sub-paths (path from the `base_url`) are in the Array (case-insensitive). | |
| 161 | + - `:skip_patterns` [Array] | |
| 162 | + Ignores internal URLs whose sub-paths match any Regexp in the Array. | |
| 163 | + - `:only` [Array] | |
| 164 | + Ignores internal URLs whose sub-paths aren't in the Array (case-insensitive) and don't match any Regexp in `:only_patterns`. | |
| 165 | + - `:only_patterns` [Array] | |
| 166 | + Ignores internal URLs whose sub-paths don't match any Regexp in the Array and aren't in `:only`. | |
| 167 | + | |
| 168 | + If the scraper has a `root_path`, the empty and `/` paths are automatically skipped. | |
| 169 | + If `:only` or `:only_patterns` is set, the root path is automatically added to `:only`. | |
| 170 | + | |
| 171 | + _Note: pages can be excluded from the index based on their content using the [`Entries`](./filter-reference.md#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._ | |
| 172 | + | |
| 173 | +* [`AttributionFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/attribution.rb) | |
| 174 | + | |
| 175 | + - `:attribution` [String] **(required)** | |
| 176 | + An HTML string with the copyright and license information. See the other scrapers for examples. | |
| 177 | + | |
| 178 | +* [`TitleFilter`](https://github.com/Thibaut/devdocs/blob/master/lib/docs/filters/core/title.rb) | |
| 179 | + | |
| 180 | + - `:title` [String or Boolean or Proc] | |
| 181 | + Unless the value is `false`, adds a title to every page. | |
| 182 | + If the value is `nil`, the title is the name of the page as determined by the [`Entries`](./filter-reference.md#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. | |
| 183 | + - `:root_title` [String or Boolean] | |
| 184 | + Overrides the `:title` option for the root page only. | |
| 185 | + | |
| 186 | + _Note: this filter is disabled by default._ | |
| 187 | + | |
| 188 | +## Keeping scrapers up-to-date | |
| 189 | + | |
| 190 | +In order to keep scrapers up-to-date the `get_latest_version(opts)` method should be overridden. If `self.release` is defined, this should return the latest version of the documentation. If `self.release` is not defined, it should return the Epoch time when the documentation was last modified. If the documentation will never change, simply return `1.0.0`. The result of this method is periodically reported in a "Documentation versions report" issue which helps maintainers keep track of outdated documentations. | |
| 191 | + | |
| 192 | +To make life easier, there are a few utility methods that you can use in `get_latest_version`: | |
| 193 | +* `fetch(url, opts)` | |
| 194 | + | |
| 195 | + Makes a GET request to the url and returns the response body. | |
| 196 | + | |
| 197 | + Example: [lib/docs/scrapers/bash.rb](../lib/docs/scrapers/bash.rb) | |
| 198 | +* `fetch_doc(url, opts)` | |
| 199 | + | |
| 200 | + Makes a GET request to the url and returns the HTML body converted to a Nokogiri document. | |
| 201 | + | |
| 202 | + Example: [lib/docs/scrapers/git.rb](../lib/docs/scrapers/git.rb) | |
| 203 | +* `fetch_json(url, opts)` | |
| 204 | + | |
| 205 | + Makes a GET request to the url and returns the JSON body converted to a dictionary. | |
| 206 | + | |
| 207 | + Example: [lib/docs/scrapers/mdn/mdn.rb](../lib/docs/scrapers/mdn/mdn.rb) | |
| 208 | +* `get_npm_version(package, opts)` | |
| 209 | + | |
| 210 | + Returns the latest version of the given npm package. | |
| 211 | + | |
| 212 | + Example: [lib/docs/scrapers/bower.rb](../lib/docs/scrapers/bower.rb) | |
| 213 | +* `get_latest_github_release(owner, repo, opts)` | |
| 214 | + | |
| 215 | + Returns the tag name of the latest GitHub release of the given repository. If the tag name is preceded by a "v", the "v" will be removed. | |
| 216 | + | |
| 217 | + Example: [lib/docs/scrapers/jsdoc.rb](../lib/docs/scrapers/jsdoc.rb) | |
| 218 | +* `get_github_tags(owner, repo, opts)` | |
| 219 | + | |
| 220 | + Returns the list of tags on the given repository ([format](https://developer.github.com/v3/repos/#list-tags)). | |
| 221 | + | |
| 222 | + Example: [lib/docs/scrapers/liquid.rb](../lib/docs/scrapers/liquid.rb) | |
| 223 | +* `get_github_file_contents(owner, repo, path, opts)` | |
| 224 | + | |
| 225 | + Returns the contents of the requested file in the default branch of the given repository. | |
| 226 | + | |
| 227 | + Example: [lib/docs/scrapers/minitest.rb](../lib/docs/scrapers/minitest.rb) | |
| @@ -37,6 +37,9 @@ class App < Sinatra::Application · 36 unmodified lines | ||
| 37 | 37 | |
| 38 | 38 | set :csp, false |
| 39 | 39 | |
| 40 | + require 'docs' | |
| 41 | + Docs.generate_manifest | |
| 42 | + | |
| 40 | 43 | Dir[docs_path, root.join(assets_prefix, '*/')].each do |path| |
| 41 | 44 | sprockets.append_path(path) |
| 42 | 45 | end |
| @@ -50,6 +53,11 @@ class App < Sinatra::Application · 7 unmodified lines | ||
| 50 | 53 | end |
| 51 | 54 | |
| 52 | 55 | configure :test, :development do |
| 56 | + require 'thor' | |
| 57 | + load 'tasks/sprites.thor' | |
| 58 | + | |
| 59 | + SpritesCLI.new.invoke(:generate) | |
| 60 | + | |
| 53 | 61 | require 'active_support/per_thread_registry' |
| 54 | 62 | require 'active_support/cache' |
| 55 | 63 | sprockets.cache = ActiveSupport::Cache.lookup_store :file_store, root.join('tmp', 'cache', 'assets', environment.to_s) |
| @@ -192,35 +200,45 @@ class App < Sinatra::Application · 136 unmodified lines | ||
| 192 | 200 | request.query_string.empty? ? nil : "?#{request.query_string}" |
| 193 | 201 | end |
| 194 | 202 | |
| 195 | − def manifest_asset_urls | |
| 196 | − @@manifest_asset_urls ||= [ | |
| 203 | + def service_worker_asset_urls | |
| 204 | + @@service_worker_asset_urls ||= [ | |
| 197 | 205 | javascript_path('application', asset_host: false), |
| 198 | 206 | stylesheet_path('application'), |
| 199 | − image_path('docs-1.png'), | |
| 200 | − image_path('docs-1@2x.png'), | |
| 201 | − image_path('docs-2.png'), | |
| 202 | − image_path('docs-2@2x.png'), | |
| 203 | − asset_path('docs.js') | |
| 204 | − ] | |
| 207 | + image_path('sprites/docs.png'), | |
| 208 | + image_path('sprites/docs@2x.png'), | |
| 209 | + asset_path('docs.js'), | |
| 210 | + App.production? ? nil : javascript_path('debug'), | |
| 211 | + ].compact | |
| 205 | 212 | end |
| 206 | 213 | |
| 207 | − def app_size | |
| 208 | − @app_size ||= memoized_cookies['size'].nil? ? '20rem' : "#{memoized_cookies['size']}px" | |
| 209 | − end | |
| 214 | + # Returns a cache name for the service worker to use which changes if any of the assets changes | |
| 215 | + # When a manifest exist, this name is only created once based on the asset manifest because it never changes without a server restart | |
| 216 | + # If a manifest does not exist, it is created every time this method is called because the assets can change while the server is running | |
| 217 | + def service_worker_cache_name | |
| 218 | + if File.exist?(App.assets_manifest_path) | |
| 219 | + if defined?(@@service_worker_cache_name) | |
| 220 | + return @@service_worker_cache_name | |
| 221 | + end | |
| 210 | 222 | |
| 211 | − def app_layout | |
| 212 | − memoized_cookies['layout'] | |
| 213 | − end | |
| 223 | + digest = Sprockets::Manifest | |
| 224 | + .new(nil, App.assets_manifest_path) | |
| 225 | + .files | |
| 226 | + .values | |
| 227 | + .map {|file| file["digest"]} | |
| 228 | + .join | |
| 214 | 229 | |
| 215 | − def app_theme | |
| 216 | − @app_theme ||= memoized_cookies['dark'].nil? ? 'default' : 'dark' | |
| 217 | − end | |
| 230 | + return @@service_worker_cache_name ||= Digest::MD5.hexdigest(digest) | |
| 231 | + else | |
| 232 | + paths = App.sprockets | |
| 233 | + .each_file | |
| 234 | + .to_a | |
| 235 | + .reject {|file| file.start_with?(App.docs_path)} | |
| 218 | 236 | |
| 219 | − def dark_theme? | |
| 220 | − app_theme == 'dark' | |
| 237 | + return App.sprockets.pack_hexdigest(App.sprockets.files_digest(paths)) | |
| 238 | + end | |
| 221 | 239 | end |
| 222 | 240 | |
| 223 | − def redirect_via_js(path) # courtesy of HTML5 App Cache | |
| 241 | + def redirect_via_js(path) | |
| 224 | 242 | response.set_cookie :initial_path, value: path, expires: Time.now + 15, path: '/' |
| 225 | 243 | redirect '/', 302 |
| 226 | 244 | end |
| @@ -243,15 +261,15 @@ class App < Sinatra::Application · 16 unmodified lines | ||
| 243 | 261 | end |
| 244 | 262 | end |
| 245 | 263 | |
| 246 | − get '/manifest.appcache' do | |
| 247 | − content_type 'text/cache-manifest' | |
| 264 | + get '/service-worker.js' do | |
| 265 | + content_type 'application/javascript' | |
| 248 | 266 | expires 0, :'no-cache' |
| 249 | − erb :manifest | |
| 267 | + erb :'service-worker.js' | |
| 250 | 268 | end |
| 251 | 269 | |
| 252 | 270 | get '/' do |
| 253 | 271 | return redirect "/#q=#{params[:q]}" if params[:q] |
| 254 | − return redirect '/' unless request.query_string.empty? # courtesy of HTML5 App Cache | |
| 272 | + return redirect '/' unless request.query_string.empty? | |
| 255 | 273 | response.headers['Content-Security-Policy'] = settings.csp if settings.csp |
| 256 | 274 | erb :index |
| 257 | 275 | end |
| @@ -152,7 +152,6 @@ module Docs · 151 unmodified lines | ||
| 152 | 152 | end |
| 153 | 153 | end |
| 154 | 154 | |
| 155 | − | |
| 156 | 155 | def initialize |
| 157 | 156 | raise NotImplementedError, "#{self.class} is an abstract class and cannot be instantiated." if self.class.abstract |
| 158 | 157 | end |
| @@ -164,5 +163,104 @@ module Docs · 5 unmodified lines | ||
| 164 | 163 | def build_pages(&block) |
| 165 | 164 | raise NotImplementedError |
| 166 | 165 | end |
| 166 | + | |
| 167 | + def get_scraper_version(opts) | |
| 168 | + if self.class.method_defined?(:options) and !options[:release].nil? | |
| 169 | + options[:release] | |
| 170 | + else | |
| 171 | + # If options[:release] does not exist, we return the Epoch timestamp of when the doc was last modified in DevDocs production | |
| 172 | + json = fetch_json('https://devdocs.io/docs.json', opts) | |
| 173 | + items = json.select {|item| item['name'] == self.class.name} | |
| 174 | + items = items.map {|item| item['mtime']} | |
| 175 | + items.max | |
| 176 | + end | |
| 177 | + end | |
| 178 | + | |
| 179 | + # Should return the latest version of this documentation | |
| 180 | + # If options[:release] is defined, it should be in the same format | |
| 181 | + # If options[:release] is not defined, it should return the Epoch timestamp of when the documentation was last updated | |
| 182 | + # If the docs will never change, simply return '1.0.0' | |
| 183 | + def get_latest_version(opts) | |
| 184 | + raise NotImplementedError | |
| 185 | + end | |
| 186 | + | |
| 187 | + # Returns whether or not this scraper is outdated. | |
| 188 | + # | |
| 189 | + # The default implementation assumes the documentation uses a semver(-like) approach when it comes to versions. | |
| 190 | + # Patch updates are ignored because there are usually little to no documentation changes in bug-fix-only releases. | |
| 191 | + # | |
| 192 | + # Scrapers of documentations that do not use this versioning approach should override this method. | |
| 193 | + # | |
| 194 | + # Examples of the default implementation: | |
| 195 | + # 1 -> 2 = outdated | |
| 196 | + # 1.1 -> 1.2 = outdated | |
| 197 | + # 1.1.1 -> 1.1.2 = not outdated | |
| 198 | + def is_outdated(scraper_version, latest_version) | |
| 199 | + scraper_parts = scraper_version.to_s.split(/\./).map(&:to_i) | |
| 200 | + latest_parts = latest_version.to_s.split(/\./).map(&:to_i) | |
| 201 | + | |
| 202 | + # Only check the first two parts, the third part is for patch updates | |
| 203 | + [0, 1].each do |i| | |
| 204 | + break if i >= scraper_parts.length or i >= latest_parts.length | |
| 205 | + return true if latest_parts[i] > scraper_parts[i] | |
| 206 | + return false if latest_parts[i] < scraper_parts[i] | |
| 207 | + end | |
| 208 | + | |
| 209 | + false | |
| 210 | + end | |
| 211 | + | |
| 212 | + private | |
| 213 | + | |
| 214 | + # | |
| 215 | + # Utility methods for get_latest_version | |
| 216 | + # | |
| 217 | + | |
| 218 | + def fetch(url, opts) | |
| 219 | + headers = {} | |
| 220 | + | |
| 221 | + if opts.key?(:github_token) and url.start_with?('https://api.github.com/') | |
| 222 | + headers['Authorization'] = "token #{opts[:github_token]}" | |
| 223 | + end | |
| 224 | + | |
| 225 | + opts[:logger].debug("Fetching #{url}") | |
| 226 | + response = Request.run(url, { connecttimeout: 15, headers: headers }) | |
| 227 | + | |
| 228 | + if response.success? | |
| 229 | + response.body | |
| 230 | + else | |
| 231 | + reason = response.timed_out? ? "Timed out while connecting to #{url}" : "Couldn't fetch #{url} (response code #{response.code})" | |
| 232 | + opts[:logger].error(reason) | |
| 233 | + raise reason | |
| 234 | + end | |
| 235 | + end | |
| 236 | + | |
| 237 | + def fetch_doc(url, opts) | |
| 238 | + body = fetch(url, opts) | |
| 239 | + Nokogiri::HTML.parse(body, nil, 'UTF-8') | |
| 240 | + end | |
| 241 | + | |
| 242 | + def fetch_json(url, opts) | |
| 243 | + JSON.parse fetch(url, opts) | |
| 244 | + end | |
| 245 | + | |
| 246 | + def get_npm_version(package, opts) | |
| 247 | + json = fetch_json("https://registry.npmjs.com/#{package}", opts) | |
| 248 | + json['dist-tags']['latest'] | |
| 249 | + end | |
| 250 | + | |
| 251 | + def get_latest_github_release(owner, repo, opts) | |
| 252 | + release = fetch_json("https://api.github.com/repos/#{owner}/#{repo}/releases/latest", opts) | |
| 253 | + tag_name = release['tag_name'] | |
| 254 | + tag_name.start_with?('v') ? tag_name[1..-1] : tag_name | |
| 255 | + end | |
| 256 | + | |
| 257 | + def get_github_tags(owner, repo, opts) | |
| 258 | + fetch_json("https://api.github.com/repos/#{owner}/#{repo}/tags", opts) | |
| 259 | + end | |
| 260 | + | |
| 261 | + def get_github_file_contents(owner, repo, path, opts) | |
| 262 | + json = fetch_json("https://api.github.com/repos/#{owner}/#{repo}/contents/#{path}", opts) | |
| 263 | + Base64.decode64(json['content']) | |
| 264 | + end | |
| 167 | 265 | end |
| 168 | 266 | end |
| @@ -22,7 +22,7 @@ module Docs · 21 unmodified lines | ||
| 22 | 22 | def initialize(options = {}) |
| 23 | 23 | @request_options = options.extract!(:request_options)[:request_options].try(:dup) || {} |
| 24 | 24 | options[:max_concurrency] ||= 20 |
| 25 | − options[:pipelining] = false | |
| 25 | + options[:pipelining] = 0 | |
| 26 | 26 | super |
| 27 | 27 | end |
| 28 | 28 | |
| @@ -29,7 +29,7 @@ module Docs · 28 unmodified lines | ||
| 29 | 29 | |
| 30 | 30 | def request_one(url) |
| 31 | 31 | assert_source_directory_exists |
| 32 | − Response.new read_file(url_to_path(url)), URL.parse(url) | |
| 32 | + Response.new read_file(File.join(source_directory, url_to_path(url))), URL.parse(url) | |
| 33 | 33 | end |
| 34 | 34 | |
| 35 | 35 | def request_all(urls) |
| @@ -50,7 +50,7 @@ module Docs · 14 unmodified lines | ||
| 50 | 50 | end |
| 51 | 51 | |
| 52 | 52 | def read_file(path) |
| 53 | − File.read(File.join(source_directory, path)) | |
| 53 | + File.read(path) | |
| 54 | 54 | rescue |
| 55 | 55 | instrument 'warn.doc', msg: "Failed to open file: #{path}" |
| 56 | 56 | nil |
| @@ -72,7 +72,7 @@ module Docs · 71 unmodified lines | ||
| 72 | 72 | |
| 73 | 73 | if base == dest |
| 74 | 74 | '' |
| 75 | − elsif dest.start_with? File.join(base, '') | |
| 75 | + elsif dest.start_with?(::File.join(base, '')) | |
| 76 | 76 | url.path[(path.length)..-1] |
| 77 | 77 | end |
| 78 | 78 | end |
| @@ -20,6 +20,7 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | 'prop_sf' => 'Properties: Source Files', |
| 21 | 21 | 'prop_test' => 'Properties: Tests', |
| 22 | 22 | 'prop_tgt' => 'Properties: Targets', |
| 23 | + 'envvar' => 'Environment Variables', | |
| 23 | 24 | 'variable' => 'Variables' } |
| 24 | 25 | |
| 25 | 26 | def get_name |
| @@ -0,0 +1,35 @@ | ||
| 1 | +module Docs | |
| 2 | + class Composer | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + # Remove unneeded elements | |
| 6 | + css('#searchbar, .toc, .fork-and-edit, .anchor').remove | |
| 7 | + | |
| 8 | + # Fix the home page titles | |
| 9 | + if subpath == '' | |
| 10 | + css('h1').each do |node| | |
| 11 | + node.name = 'h2' | |
| 12 | + end | |
| 13 | + | |
| 14 | + # Add a main title before the first subtitle | |
| 15 | + at_css('h2').before('<h1>Composer</h1>') | |
| 16 | + end | |
| 17 | + | |
| 18 | + # Code blocks | |
| 19 | + css('pre').each do |node| | |
| 20 | + code = node.at_css('code[class]') | |
| 21 | + | |
| 22 | + unless code.nil? | |
| 23 | + node['data-language'] = 'javascript' if code['class'].include?('javascript') | |
| 24 | + node['data-language'] = 'php' if code['class'].include?('php') | |
| 25 | + end | |
| 26 | + | |
| 27 | + node.content = node.content.strip | |
| 28 | + node.remove_attribute('class') | |
| 29 | + end | |
| 30 | + | |
| 31 | + doc | |
| 32 | + end | |
| 33 | + end | |
| 34 | + end | |
| 35 | +end | |
| @@ -0,0 +1,36 @@ | ||
| 1 | +module Docs | |
| 2 | + class Composer | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + def get_name | |
| 5 | + title = at_css('h1').content | |
| 6 | + title = "#{Integer(subpath[1]) + 1}. #{title}" if type == 'Book' | |
| 7 | + title | |
| 8 | + end | |
| 9 | + | |
| 10 | + def get_type | |
| 11 | + return 'Articles' if subpath.start_with?('articles/') | |
| 12 | + 'Book' | |
| 13 | + end | |
| 14 | + | |
| 15 | + def additional_entries | |
| 16 | + entries = [] | |
| 17 | + | |
| 18 | + if subpath == '04-schema.md' # JSON Schema | |
| 19 | + css('h3').each do |node| | |
| 20 | + name = node.content.strip | |
| 21 | + name.remove!(' (root-only)') | |
| 22 | + entries << [name, node['id'], 'JSON Schema'] | |
| 23 | + end | |
| 24 | + end | |
| 25 | + | |
| 26 | + if subpath == '06-config.md' # Composer config | |
| 27 | + css('h2').each do |node| | |
| 28 | + entries << [node.content.strip, node['id'], 'Configuration Options'] | |
| 29 | + end | |
| 30 | + end | |
| 31 | + | |
| 32 | + entries | |
| 33 | + end | |
| 34 | + end | |
| 35 | + end | |
| 36 | +end | |
| @@ -0,0 +1,26 @@ | ||
| 1 | +# frozen_string_literal: true | |
| 2 | + | |
| 3 | +module Docs | |
| 4 | + class Cypress | |
| 5 | + class CleanHtmlFilter < Filter | |
| 6 | + def call | |
| 7 | + article_div = at_css('#article > div') | |
| 8 | + @doc = article_div unless article_div.nil? | |
| 9 | + | |
| 10 | + header = at_css('h1.article-title') | |
| 11 | + doc.prepend_child(header) unless header.nil? | |
| 12 | + | |
| 13 | + css('.article-edit-link').remove | |
| 14 | + css('.article-footer').remove | |
| 15 | + css('.article-footer-updated').remove | |
| 16 | + | |
| 17 | + css('pre').each do |node| | |
| 18 | + node.content = node.content | |
| 19 | + node['data-language'] = 'javascript' | |
| 20 | + end | |
| 21 | + | |
| 22 | + doc | |
| 23 | + end | |
| 24 | + end | |
| 25 | + end | |
| 26 | +end | |
| @@ -0,0 +1,34 @@ | ||
| 1 | +# frozen_string_literal: true | |
| 2 | + | |
| 3 | +module Docs | |
| 4 | + class Cypress | |
| 5 | + class EntriesFilter < Docs::EntriesFilter | |
| 6 | + SECTIONS = %w[ | |
| 7 | + commands | |
| 8 | + core-concepts | |
| 9 | + cypress-api | |
| 10 | + events | |
| 11 | + getting-started | |
| 12 | + guides | |
| 13 | + overview | |
| 14 | + plugins | |
| 15 | + references | |
| 16 | + utilities | |
| 17 | + ].freeze | |
| 18 | + | |
| 19 | + def get_name | |
| 20 | + at_css('h1.article-title').content.strip | |
| 21 | + end | |
| 22 | + | |
| 23 | + def get_type | |
| 24 | + path = context[:url].path | |
| 25 | + | |
| 26 | + SECTIONS.each do |section| | |
| 27 | + if path.match?("/#{section}/") | |
| 28 | + return section.split('-').map(&:capitalize).join(' ') | |
| 29 | + end | |
| 30 | + end | |
| 31 | + end | |
| 32 | + end | |
| 33 | + end | |
| 34 | +end | |
| @@ -57,6 +57,11 @@ module Docs · 56 unmodified lines | ||
| 57 | 57 | node.parent.after(node) |
| 58 | 58 | end |
| 59 | 59 | |
| 60 | + css('.signature').each do |node| | |
| 61 | + non_text_children = node.xpath('node()[not(self::text())]') | |
| 62 | + non_text_children.to_a.reverse.each { |child| node.parent.add_next_sibling(child) } | |
| 63 | + end | |
| 64 | + | |
| 60 | 65 | css('pre').each do |node| |
| 61 | 66 | node['data-language'] = 'elixir' |
| 62 | 67 | node.content = node.content |
| @@ -17,6 +17,7 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | css('#plusone', '#nav', '.pkgGopher', '#footer', '.collapsed', '.permalink', '#pkg-callgraph').remove |
| 18 | 18 | |
| 19 | 19 | css('span[style]', '.toggleVisible', '.expanded', 'div.toggle').each do |node| |
| 20 | + node.first_element_child['id'] = node['id'] if node['id'] | |
| 20 | 21 | node.before(node.children).remove |
| 21 | 22 | end |
| 22 | 23 | |
| @@ -4,6 +4,11 @@ module Docs · 3 unmodified lines | ||
| 4 | 4 | def call |
| 5 | 5 | css('hr') |
| 6 | 6 | |
| 7 | + if at_css('h1').nil? | |
| 8 | + title = current_url.normalized_path[1..-1].gsub(/-/, ' ') | |
| 9 | + doc.children.before("<h1>#{title}</h1>") | |
| 10 | + end | |
| 11 | + | |
| 7 | 12 | css('div.highlighter-rouge').each do |node| |
| 8 | 13 | lang = node['class'][/language-(\w+)/, 1] |
| 9 | 14 | node['data-language'] = lang if lang |
| @@ -2,7 +2,8 @@ module Docs · 1 unmodified line | ||
| 2 | 2 | class Homebrew |
| 3 | 3 | class EntriesFilter < Docs::EntriesFilter |
| 4 | 4 | def get_name |
| 5 | − name = at_css('h1').content.strip | |
| 5 | + header = at_css('h1') | |
| 6 | + name = header.nil? ? current_url.normalized_path[1..-1].gsub(/-/, ' ') : header.content.strip | |
| 6 | 7 | name.remove! %r{\(.*} |
| 7 | 8 | name |
| 8 | 9 | end |
| @@ -16,6 +17,7 @@ module Docs · 7 unmodified lines | ||
| 16 | 17 | Python-for-Formula-Authors |
| 17 | 18 | Migrating-A-Formula-To-A-Tap |
| 18 | 19 | Rename-A-Formula |
| 20 | + Building-Against-Non-Homebrew-Dependencies | |
| 19 | 21 | How-to-Create-and-Maintain-a-Tap |
| 20 | 22 | Brew-Test-Bot |
| 21 | 23 | Prose-Style-Guidelines) |
| @@ -46,6 +46,13 @@ module Docs · 45 unmodified lines | ||
| 46 | 46 | parent.content = parent.content |
| 47 | 47 | parent['data-language'] = 'kotlin' |
| 48 | 48 | end |
| 49 | + | |
| 50 | + css('.tags').each do |wrapper| | |
| 51 | + platforms = wrapper.css('.platform:not(.tag-value-Common)').to_a | |
| 52 | + platforms = platforms.map { |node| "#{node.content} (#{node['data-tag-version']})" } | |
| 53 | + platforms = "<b>Platform and version requirements:</b> #{platforms.join ", "}" | |
| 54 | + wrapper.replace(platforms) | |
| 55 | + end | |
| 49 | 56 | end |
| 50 | 57 | end |
| 51 | 58 | end |
| @@ -5,7 +5,9 @@ module Docs · 4 unmodified lines | ||
| 5 | 5 | if subpath.start_with?('api') |
| 6 | 6 | breadcrumbs[1..-1].join('.') |
| 7 | 7 | else |
| 8 | − (at_css('h1') || at_css('h2')).content | |
| 8 | + node = (at_css('h1') || at_css('h2')) | |
| 9 | + return node.content unless node.nil? | |
| 10 | + subpath[/\/([a-z0-9_-]+)\./][1..-2].titleize.sub('Faq', 'FAQ') | |
| 9 | 11 | end |
| 10 | 12 | end |
| 11 | 13 | |
| @@ -2,8 +2,10 @@ module Docs · 1 unmodified line | ||
| 2 | 2 | class Pandas |
| 3 | 3 | class EntriesFilter < Docs::EntriesFilter |
| 4 | 4 | def get_name |
| 5 | − if subpath.start_with?('generated') | |
| 6 | − name = at_css('dt').content.strip | |
| 5 | + if subpath.start_with?('generated') || (subpath.include?('reference') && !subpath.include?('reference/index')) | |
| 6 | + name_node = at_css('dt') | |
| 7 | + name_node = at_css('h1') if name_node.nil? | |
| 8 | + name = name_node.content.strip | |
| 7 | 9 | name.sub! %r{\(.*}, '()' |
| 8 | 10 | name.remove! %r{\s=.*} |
| 9 | 11 | name.remove! %r{\A(class(method)?) (pandas\.)?} |
| @@ -16,7 +18,7 @@ module Docs · 6 unmodified lines | ||
| 16 | 18 | end |
| 17 | 19 | |
| 18 | 20 | def get_type |
| 19 | − if subpath.start_with?('generated') | |
| 21 | + if subpath.start_with?('generated') || (subpath.include?('reference') && !subpath.include?('reference/index')) | |
| 20 | 22 | css('.toctree-l2.current > a').last.content.remove(/\s\(.+?\)/) |
| 21 | 23 | else |
| 22 | 24 | 'Manual' |
| @@ -85,7 +85,7 @@ module Docs · 84 unmodified lines | ||
| 85 | 85 | if initial_header.start_with?(@section) |
| 86 | 86 | sig.content = @section + '.' + sig.text |
| 87 | 87 | end |
| 88 | − # seperate the signatures on different lines. | |
| 88 | + # separate the signatures on different lines. | |
| 89 | 89 | header.add_child "<br>" |
| 90 | 90 | end |
| 91 | 91 | end |
| @@ -57,16 +57,10 @@ module Docs · 56 unmodified lines | ||
| 57 | 57 | clean_id_attributes |
| 58 | 58 | entries = [] |
| 59 | 59 | |
| 60 | − css('.class > dt[id]', '.exception > dt[id]', '.attribute > dt[id]').each do |node| | |
| 60 | + css('.class > dt[id]', '.exception > dt[id]', '.attribute > dt[id]', '.data > dt[id]').each do |node| | |
| 61 | 61 | entries << [node['id'], node['id']] |
| 62 | 62 | end |
| 63 | 63 | |
| 64 | − css('.data > dt[id]').each do |node| | |
| 65 | − if node['id'].split('.').last.upcase! # skip constants | |
| 66 | − entries << [node['id'], node['id']] | |
| 67 | − end | |
| 68 | − end | |
| 69 | − | |
| 70 | 64 | css('.function > dt[id]', '.method > dt[id]', '.staticmethod > dt[id]', '.classmethod > dt[id]').each do |node| |
| 71 | 65 | entries << [node['id'] + '()', node['id']] |
| 72 | 66 | end |
| @@ -27,6 +27,7 @@ module Docs · 26 unmodified lines | ||
| 27 | 27 | |
| 28 | 28 | def get_type |
| 29 | 29 | return 'Logging' if slug.start_with? 'library/logging' |
| 30 | + return 'Asynchronous I/O' if slug.start_with? 'library/asyncio' | |
| 30 | 31 | |
| 31 | 32 | type = at_css('.related a[accesskey="U"]').content |
| 32 | 33 | |
| @@ -47,6 +48,7 @@ module Docs · 14 unmodified lines | ||
| 47 | 48 | end |
| 48 | 49 | |
| 49 | 50 | def include_default_entry? |
| 51 | + return true if slug == 'library/asyncio' | |
| 50 | 52 | !at_css('.body > .section:only-child > .toctree-wrapper:last-child') && !type.in?(%w(Superseded)) |
| 51 | 53 | end |
| 52 | 54 | |
| @@ -55,16 +57,10 @@ module Docs · 2 unmodified lines | ||
| 55 | 57 | clean_id_attributes |
| 56 | 58 | entries = [] |
| 57 | 59 | |
| 58 | − css('.class > dt[id]', '.exception > dt[id]', '.attribute > dt[id]').each do |node| | |
| 60 | + css('.class > dt[id]', '.exception > dt[id]', '.attribute > dt[id]', '.data > dt[id]').each do |node| | |
| 59 | 61 | entries << [node['id'], node['id']] |
| 60 | 62 | end |
| 61 | 63 | |
| 62 | − css('.data > dt[id]').each do |node| | |
| 63 | − if node['id'].split('.').last.upcase! # skip constants | |
| 64 | − entries << [node['id'], node['id']] | |
| 65 | − end | |
| 66 | − end | |
| 67 | − | |
| 68 | 64 | css('.function > dt[id]', '.method > dt[id]', '.staticmethod > dt[id]', '.classmethod > dt[id]').each do |node| |
| 69 | 65 | entries << [node['id'] + '()', node['id']] |
| 70 | 66 | end |
| @@ -8,6 +8,7 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | # QML property/method header |
| 9 | 9 | css('.qmlproto').each do |node| |
| 10 | 10 | id = node.at_css('tr')['id'] |
| 11 | + id = node.at_css('a')['name'] if id.blank? | |
| 11 | 12 | node.inner_html = node.at_css('td').inner_html |
| 12 | 13 | node.name = 'h3' |
| 13 | 14 | node['id'] = id |
| @@ -111,6 +111,7 @@ module Docs · 110 unmodified lines | ||
| 111 | 111 | css('.qmlproto').each do |node| |
| 112 | 112 | title = node.content.strip |
| 113 | 113 | id = node.at_css('tr')['id'] |
| 114 | + id = node.at_css('a')['name'] if id.blank? | |
| 114 | 115 | |
| 115 | 116 | # Remove options |
| 116 | 117 | title.remove!(%r{^\[.*\] }) |
| @@ -11,7 +11,7 @@ module Docs · 10 unmodified lines | ||
| 11 | 11 | css('.card').each do |card| |
| 12 | 12 | title = card.at_css('h2') |
| 13 | 13 | added_in = card.at_css('small') |
| 14 | − added_in.parent = title | |
| 14 | + added_in.parent = title if added_in.present? | |
| 15 | 15 | end |
| 16 | 16 | |
| 17 | 17 | css('.params').each do |node| |
| @@ -37,8 +37,10 @@ module Docs · 36 unmodified lines | ||
| 37 | 37 | end |
| 38 | 38 | |
| 39 | 39 | # Add class to differentiate Ruby code from C code |
| 40 | − css('.method-source-code > pre').each do |node| | |
| 41 | − node['class'] = node.at_css('.ruby-keyword') ? 'ruby' : 'c' | |
| 40 | + css('.method-source-code').each do |node| | |
| 41 | + node.parent.prepend_child(node) | |
| 42 | + pre = node.at_css('pre') | |
| 43 | + pre['class'] = pre.at_css('.ruby-keyword') ? 'ruby' : 'c' | |
| 42 | 44 | end |
| 43 | 45 | |
| 44 | 46 | # Remove code highlighting |
| @@ -0,0 +1,27 @@ | ||
| 1 | +module Docs | |
| 2 | + class SaltStack | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + if root_page? | |
| 6 | + doc.inner_html = '<h1>SaltStack</h1>' | |
| 7 | + return doc | |
| 8 | + end | |
| 9 | + | |
| 10 | + css('.headerlink').remove | |
| 11 | + | |
| 12 | + css('div[class^="highlight-"]').each do |node| | |
| 13 | + node.name = 'pre' | |
| 14 | + node['data-language'] = node['class'].scan(/highlight-([a-z]+)/i)[0][0] | |
| 15 | + node.content = node.content.strip | |
| 16 | + end | |
| 17 | + | |
| 18 | + css('.function > dt').each do |node| | |
| 19 | + node.name = 'h3' | |
| 20 | + node.content = node.content | |
| 21 | + end | |
| 22 | + | |
| 23 | + doc | |
| 24 | + end | |
| 25 | + end | |
| 26 | + end | |
| 27 | +end | |
| @@ -0,0 +1,38 @@ | ||
| 1 | +module Docs | |
| 2 | + class SaltStack | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + SALT_REF_RGX = /salt\.([^\.]+)\.([^\s]+)/ | |
| 5 | + | |
| 6 | + def get_name | |
| 7 | + header = at_css('h1').content | |
| 8 | + | |
| 9 | + ref_match = SALT_REF_RGX.match(header) | |
| 10 | + if ref_match | |
| 11 | + ns, mod = ref_match.captures | |
| 12 | + "#{ns}.#{mod}" | |
| 13 | + else | |
| 14 | + header | |
| 15 | + end | |
| 16 | + end | |
| 17 | + | |
| 18 | + def get_type | |
| 19 | + slug.split('/', 3)[1] | |
| 20 | + end | |
| 21 | + | |
| 22 | + def include_default_entry? | |
| 23 | + slug.split('/').last.start_with? 'salt' | |
| 24 | + end | |
| 25 | + | |
| 26 | + def additional_entries | |
| 27 | + entries = [] | |
| 28 | + | |
| 29 | + css('.function > h3').each do |node| | |
| 30 | + name = node.content.remove('salt.').split('(')[0] + '()' | |
| 31 | + entries << [name, node['id']] | |
| 32 | + end | |
| 33 | + | |
| 34 | + entries | |
| 35 | + end | |
| 36 | + end | |
| 37 | + end | |
| 38 | +end | |
| @@ -0,0 +1,109 @@ | ||
| 1 | +module Docs | |
| 2 | + class Scala | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + @doc = at_css('#content') | |
| 6 | + | |
| 7 | + always | |
| 8 | + add_title | |
| 9 | + | |
| 10 | + doc | |
| 11 | + end | |
| 12 | + | |
| 13 | + def always | |
| 14 | + # Remove deprecated sections | |
| 15 | + css('.members').each do |members| | |
| 16 | + header = members.at_css('h3') | |
| 17 | + members.remove if header.text.downcase.include? 'deprecate' | |
| 18 | + end | |
| 19 | + | |
| 20 | + css('#mbrsel, #footer').remove | |
| 21 | + | |
| 22 | + css('.diagram-container').remove | |
| 23 | + css('.toggleContainer > .toggle').each do |node| | |
| 24 | + title = node.at_css('span') | |
| 25 | + next if title.nil? | |
| 26 | + | |
| 27 | + content = node.at_css('.hiddenContent') | |
| 28 | + next if content.nil? | |
| 29 | + | |
| 30 | + title.name = 'dt' | |
| 31 | + | |
| 32 | + content.remove_attribute('class') | |
| 33 | + content.remove_attribute('style') | |
| 34 | + content.name = 'dd' | |
| 35 | + | |
| 36 | + attributes = at_css('.attributes') | |
| 37 | + unless attributes.nil? | |
| 38 | + title.parent = attributes | |
| 39 | + content.parent = attributes | |
| 40 | + end | |
| 41 | + end | |
| 42 | + | |
| 43 | + signature = at_css('#signature') | |
| 44 | + signature.replace "<h2 id=\"signature\">#{signature.inner_html}</h2>" | |
| 45 | + | |
| 46 | + css('div.members > h3').each do |node| | |
| 47 | + node.name = 'h2' | |
| 48 | + end | |
| 49 | + | |
| 50 | + css('div.members > ol').each do |list| | |
| 51 | + list.css('li').each do |li| | |
| 52 | + h3 = doc.document.create_element 'h3' | |
| 53 | + h3['id'] = li['name'].rpartition('#').last unless li['name'].nil? | |
| 54 | + | |
| 55 | + li.prepend_child h3 | |
| 56 | + li.css('.shortcomment').remove | |
| 57 | + | |
| 58 | + modifier = li.at_css('.modifier_kind') | |
| 59 | + modifier.parent = h3 unless modifier.nil? | |
| 60 | + | |
| 61 | + kind = li.at_css('.modifier_kind .kind') | |
| 62 | + kind.content = kind.content + ' ' unless kind.nil? | |
| 63 | + | |
| 64 | + symbol = li.at_css('.symbol') | |
| 65 | + symbol.parent = h3 unless symbol.nil? | |
| 66 | + | |
| 67 | + li.swap li.children | |
| 68 | + end | |
| 69 | + | |
| 70 | + list.swap list.children | |
| 71 | + end | |
| 72 | + | |
| 73 | + css('.fullcomment pre, .fullcommenttop pre').each do |pre| | |
| 74 | + pre['data-language'] = 'scala' | |
| 75 | + pre.content = pre.content | |
| 76 | + end | |
| 77 | + | |
| 78 | + # Sections of the documentation which do not seem useful | |
| 79 | + %w(#inheritedMembers #groupedMembers .permalink .hiddenContent .material-icons).each do |selector| | |
| 80 | + css(selector).remove | |
| 81 | + end | |
| 82 | + | |
| 83 | + # Things that are not shown on the site, like deprecated members | |
| 84 | + css('li[visbl=prt]').remove | |
| 85 | + end | |
| 86 | + | |
| 87 | + def add_title | |
| 88 | + css('.permalink').remove | |
| 89 | + | |
| 90 | + definition = at_css('#definition') | |
| 91 | + return if definition.nil? | |
| 92 | + | |
| 93 | + type_full_name = {a: 'Annotation', c: 'Class', t: 'Trait', o: 'Object', p: 'Package'} | |
| 94 | + type = type_full_name[definition.at_css('.big-circle').text.to_sym] | |
| 95 | + name = CGI.escapeHTML definition.at_css('h1').text | |
| 96 | + | |
| 97 | + package = definition.at_css('#owner').text rescue '' | |
| 98 | + package = package + '.' unless name.empty? || package.empty? | |
| 99 | + | |
| 100 | + other = definition.at_css('.morelinks').dup | |
| 101 | + other_content = other ? "<h3>#{other.to_html}</h3>" : '' | |
| 102 | + | |
| 103 | + title_content = root_page? ? 'Package root' : "#{type} #{package}#{name}".strip | |
| 104 | + title = "<h1>#{title_content}</h1>" | |
| 105 | + definition.replace title + other_content | |
| 106 | + end | |
| 107 | + end | |
| 108 | + end | |
| 109 | +end | |
| @@ -0,0 +1,103 @@ | ||
| 1 | +module Docs | |
| 2 | + class Scala | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + REPLACEMENTS = { | |
| 5 | + '$eq' => '=', | |
| 6 | + '$colon' => ':', | |
| 7 | + '$less' => '<', | |
| 8 | + } | |
| 9 | + | |
| 10 | + def get_name | |
| 11 | + if is_package? | |
| 12 | + symbol = at_css('#definition h1') | |
| 13 | + symbol ? symbol.text.gsub(/\W+/, '') : "package" | |
| 14 | + else | |
| 15 | + name = slug.split('/').last | |
| 16 | + | |
| 17 | + # Some objects have inner objects, show ParentObject$.ChildObject$ instead of ParentObject$$ChildObject$ | |
| 18 | + name = name.gsub('$$', '$.') | |
| 19 | + | |
| 20 | + REPLACEMENTS.each do |key, value| | |
| 21 | + name = name.gsub(key, value) | |
| 22 | + end | |
| 23 | + | |
| 24 | + # If a dollar sign is used as separator between two characters, replace it with a dot | |
| 25 | + name.gsub(/([^$.])\$([^$.])/, '\1.\2') | |
| 26 | + end | |
| 27 | + end | |
| 28 | + | |
| 29 | + def get_type | |
| 30 | + # if this entry is for a package, we group the package under the parent package | |
| 31 | + if is_package? | |
| 32 | + parent_package | |
| 33 | + # otherwise, group it under the regular package name | |
| 34 | + else | |
| 35 | + package_name | |
| 36 | + end | |
| 37 | + end | |
| 38 | + | |
| 39 | + def include_default_entry? | |
| 40 | + true | |
| 41 | + end | |
| 42 | + | |
| 43 | + def additional_entries | |
| 44 | + entries = [] | |
| 45 | + | |
| 46 | + full_name = "#{type}.#{name}".remove('$') | |
| 47 | + css(".members li[name^=\"#{full_name}\"]").each do |node| | |
| 48 | + # Ignore packages | |
| 49 | + kind = node.at_css('.modifier_kind > .kind') | |
| 50 | + next if !kind.nil? && kind.content == 'package' | |
| 51 | + | |
| 52 | + # Ignore deprecated members | |
| 53 | + next unless node.at_css('.symbol > .name.deprecated').nil? | |
| 54 | + | |
| 55 | + id = node['name'].rpartition('#').last | |
| 56 | + member_name = node.at_css('.name') | |
| 57 | + | |
| 58 | + # Ignore members only existing of hashtags, we can't link to that | |
| 59 | + next if member_name.nil? || member_name.content.strip.remove('#').blank? | |
| 60 | + | |
| 61 | + member = "#{name}.#{member_name.content}()" | |
| 62 | + entries << [member, id] | |
| 63 | + end | |
| 64 | + | |
| 65 | + entries | |
| 66 | + end | |
| 67 | + | |
| 68 | + private | |
| 69 | + | |
| 70 | + # For the package name, we use the slug rather than parsing the package | |
| 71 | + # name from the HTML because companion object classes may be broken out into | |
| 72 | + # their own entries (by the source documentation). When that happens, | |
| 73 | + # we want to group these classes (like `scala.reflect.api.Annotations.Annotation`) | |
| 74 | + # under the package name, and not the fully-qualfied name which would | |
| 75 | + # include the companion object. | |
| 76 | + def package_name | |
| 77 | + name = package_drop_last(slug_parts) | |
| 78 | + name.empty? ? '_root_' : name | |
| 79 | + end | |
| 80 | + | |
| 81 | + def parent_package | |
| 82 | + parent = package_drop_last(package_name.split('.')) | |
| 83 | + parent.empty? ? '_root_' : parent | |
| 84 | + end | |
| 85 | + | |
| 86 | + def package_drop_last(parts) | |
| 87 | + parts[0...-1].join('.') | |
| 88 | + end | |
| 89 | + | |
| 90 | + def slug_parts | |
| 91 | + slug.split('/') | |
| 92 | + end | |
| 93 | + | |
| 94 | + def owner | |
| 95 | + at_css('#owner') | |
| 96 | + end | |
| 97 | + | |
| 98 | + def is_package? | |
| 99 | + slug.ends_with?('index') || slug.ends_with?('package') | |
| 100 | + end | |
| 101 | + end | |
| 102 | + end | |
| 103 | +end | |
| @@ -0,0 +1,21 @@ | ||
| 1 | +module Docs | |
| 2 | + class VueRouter | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + @doc = at_css('.content') | |
| 6 | + | |
| 7 | + # Remove unneeded elements | |
| 8 | + css('.bit-sponsor, .header-anchor').remove | |
| 9 | + | |
| 10 | + css('.custom-block').each do |node| | |
| 11 | + node.name = 'blockquote' | |
| 12 | + | |
| 13 | + title = node.at_css('.custom-block-title') | |
| 14 | + title.name = 'strong' unless title.nil? | |
| 15 | + end | |
| 16 | + | |
| 17 | + doc | |
| 18 | + end | |
| 19 | + end | |
| 20 | + end | |
| 21 | +end | |
| @@ -0,0 +1,71 @@ | ||
| 1 | +module Docs | |
| 2 | + class VueRouter | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + def get_name | |
| 5 | + name = at_css('h1').content | |
| 6 | + name.remove! '# ' | |
| 7 | + name | |
| 8 | + end | |
| 9 | + | |
| 10 | + def get_type | |
| 11 | + return 'Other Guides' if subpath.start_with?('guide/advanced') | |
| 12 | + return 'Basic Guides' if subpath.start_with?('guide') || subpath.start_with?('installation') | |
| 13 | + 'API Reference' | |
| 14 | + end | |
| 15 | + | |
| 16 | + def include_default_entry? | |
| 17 | + name != 'API Reference' | |
| 18 | + end | |
| 19 | + | |
| 20 | + def additional_entries | |
| 21 | + return [] unless subpath.start_with?('api') | |
| 22 | + | |
| 23 | + entries = [ | |
| 24 | + ['<router-link>', 'router-link', 'API Reference'], | |
| 25 | + ['<router-view>', 'router-view', 'API Reference'], | |
| 26 | + ['$route', 'the-route-object', 'API Reference'], | |
| 27 | + ['Component Injections', 'component-injections', 'API Reference'] | |
| 28 | + ] | |
| 29 | + | |
| 30 | + css('h3').each do |node| | |
| 31 | + entry_name = node.content.strip | |
| 32 | + | |
| 33 | + # Get the previous h2 title | |
| 34 | + title = node | |
| 35 | + title = title.previous_element until title.name == 'h2' | |
| 36 | + title = title.content.strip | |
| 37 | + title.remove! '# ' | |
| 38 | + | |
| 39 | + entry_name.remove! '# ' | |
| 40 | + | |
| 41 | + case title | |
| 42 | + when 'Router Construction Options' | |
| 43 | + entry_name = "RouterOptions.#{entry_name}" | |
| 44 | + when '<router-view> Props' | |
| 45 | + entry_name = "<router-view> `#{entry_name}` prop" | |
| 46 | + when '<router-link> Props' | |
| 47 | + entry_name = "<router-link> `#{entry_name}` prop" | |
| 48 | + when 'Router Instance Methods' | |
| 49 | + entry_name = "#{entry_name}()" | |
| 50 | + end | |
| 51 | + | |
| 52 | + entry_name = entry_name.split(' API ')[0] if entry_name.start_with?('v-slot') | |
| 53 | + | |
| 54 | + unless title == "Component Injections" || node['id'] == 'route-object-properties' | |
| 55 | + entries << [entry_name, node['id'], 'API Reference'] | |
| 56 | + end | |
| 57 | + end | |
| 58 | + | |
| 59 | + css('#route-object-properties + ul > li > p:first-child > strong').each do |node| | |
| 60 | + entry_name = node.content.strip | |
| 61 | + id = "route-object-#{entry_name.remove('$route.')}" | |
| 62 | + | |
| 63 | + node['id'] = id | |
| 64 | + entries << [entry_name, node['id'], 'API Reference'] | |
| 65 | + end | |
| 66 | + | |
| 67 | + entries | |
| 68 | + end | |
| 69 | + end | |
| 70 | + end | |
| 71 | +end | |
| @@ -0,0 +1,17 @@ | ||
| 1 | +module Docs | |
| 2 | + class Vuex | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + @doc = at_css('.content') | |
| 6 | + | |
| 7 | + # Remove video from root page | |
| 8 | + css('a[href="#"]').remove if root_page? | |
| 9 | + | |
| 10 | + # Remove unneeded elements | |
| 11 | + css('.header-anchor').remove | |
| 12 | + | |
| 13 | + doc | |
| 14 | + end | |
| 15 | + end | |
| 16 | + end | |
| 17 | +end | |
| @@ -0,0 +1,69 @@ | ||
| 1 | +module Docs | |
| 2 | + class Vuex | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + def get_name | |
| 5 | + name = at_css('h1').content | |
| 6 | + | |
| 7 | + name.remove! '# ' | |
| 8 | + | |
| 9 | + # Add index on guides | |
| 10 | + unless subpath.start_with?('api') | |
| 11 | + sidebar_link = at_css('.sidebar-link.active') | |
| 12 | + all_links = css('.sidebar-link:not([href="/"]):not([href="../index"])') | |
| 13 | + | |
| 14 | + index = all_links.index(sidebar_link) | |
| 15 | + | |
| 16 | + name.prepend "#{index + 1}. " if index | |
| 17 | + end | |
| 18 | + | |
| 19 | + name | |
| 20 | + end | |
| 21 | + | |
| 22 | + def get_type | |
| 23 | + 'Guide' | |
| 24 | + end | |
| 25 | + | |
| 26 | + def include_default_entry? | |
| 27 | + name != 'API Reference' | |
| 28 | + end | |
| 29 | + | |
| 30 | + def additional_entries | |
| 31 | + return [] unless subpath.start_with?('api') | |
| 32 | + | |
| 33 | + entries = [ | |
| 34 | + ['Component Binding Helpers', 'component-binding-helpers', 'API Reference'], | |
| 35 | + ['Store', 'vuex-store', 'API Reference'], | |
| 36 | + ] | |
| 37 | + | |
| 38 | + css('h3').each do |node| | |
| 39 | + entry_name = node.content.strip | |
| 40 | + | |
| 41 | + # Get the previous h2 title | |
| 42 | + title = node | |
| 43 | + title = title.previous_element until title.name == 'h2' | |
| 44 | + title = title.content.strip | |
| 45 | + title.remove! '# ' | |
| 46 | + | |
| 47 | + entry_name.remove! '# ' | |
| 48 | + | |
| 49 | + unless entry_name.start_with?('router.') | |
| 50 | + case title | |
| 51 | + when "Vuex.Store Constructor Options" | |
| 52 | + entry_name = "StoreOptions.#{entry_name}" | |
| 53 | + when "Vuex.Store Instance Properties" | |
| 54 | + entry_name = "Vuex.Store.#{entry_name}" | |
| 55 | + when "Vuex.Store Instance Methods" | |
| 56 | + entry_name = "Vuex.Store.#{entry_name}()" | |
| 57 | + when "Component Binding Helpers" | |
| 58 | + entry_name = "#{entry_name}()" | |
| 59 | + end | |
| 60 | + end | |
| 61 | + | |
| 62 | + entries << [entry_name, node['id'], 'API Reference'] | |
| 63 | + end | |
| 64 | + | |
| 65 | + entries | |
| 66 | + end | |
| 67 | + end | |
| 68 | + end | |
| 69 | +end | |
| @@ -0,0 +1,39 @@ | ||
| 1 | +module Docs | |
| 2 | + class Wordpress | |
| 3 | + class CleanHtmlFilter < Filter | |
| 4 | + def call | |
| 5 | + if root_page? | |
| 6 | + doc.inner_html = '<h1>WordPress</h1>' | |
| 7 | + return doc | |
| 8 | + end | |
| 9 | + | |
| 10 | + article = at_css('article[id^="post-"]') | |
| 11 | + @doc = at_css('article[id^="post-"]') unless article.nil? | |
| 12 | + | |
| 13 | + css('hr', '.screen-reader-text', '.table-of-contents', | |
| 14 | + '.anchor', '.toc-jump', '.source-code-links', '.user-notes', | |
| 15 | + '.show-more', '.hide-more').remove | |
| 16 | + | |
| 17 | + br = /<br\s?\/?>/i | |
| 18 | + | |
| 19 | + header = at_css('h1') | |
| 20 | + header.content = header.content.strip | |
| 21 | + doc.prepend_child header | |
| 22 | + | |
| 23 | + # Add PHP code highlighting | |
| 24 | + css('pre').each do |node| | |
| 25 | + node['data-language'] = 'php' | |
| 26 | + end | |
| 27 | + | |
| 28 | + css('.source-code-container').each do |node| | |
| 29 | + node.name = 'pre' | |
| 30 | + node.inner_html = node.inner_html.gsub(br, "\n") | |
| 31 | + node.content = node.content.strip | |
| 32 | + node['data-language'] = 'php' | |
| 33 | + end | |
| 34 | + | |
| 35 | + doc | |
| 36 | + end | |
| 37 | + end | |
| 38 | + end | |
| 39 | +end | |
| @@ -0,0 +1,19 @@ | ||
| 1 | +module Docs | |
| 2 | + class Wordpress | |
| 3 | + class EntriesFilter < Docs::EntriesFilter | |
| 4 | + def get_name | |
| 5 | + at_css('.breadcrumbs .trail-end').content | |
| 6 | + end | |
| 7 | + | |
| 8 | + def get_type | |
| 9 | + if subpath.starts_with?('classes') | |
| 10 | + 'Classes' | |
| 11 | + elsif subpath.starts_with?('hooks') | |
| 12 | + 'Hooks' | |
| 13 | + elsif subpath.starts_with?('functions') | |
| 14 | + 'Functions' | |
| 15 | + end | |
| 16 | + end | |
| 17 | + end | |
| 18 | + end | |
| 19 | +end | |
| @@ -155,6 +155,10 @@ module Docs · 154 unmodified lines | ||
| 155 | 155 | end |
| 156 | 156 | end |
| 157 | 157 | |
| 158 | + def get_latest_version(opts) | |
| 159 | + get_npm_version('@angular/core', opts) | |
| 160 | + end | |
| 161 | + | |
| 158 | 162 | private |
| 159 | 163 | |
| 160 | 164 | def parse(response) |
| @@ -31,10 +31,14 @@ module Docs · 30 unmodified lines | ||
| 31 | 31 | end |
| 32 | 32 | |
| 33 | 33 | options[:only_patterns] = [%r{\Aapi}, %r{\Aguide}] |
| 34 | − options[:skip] = %w(api/ng.html) | |
| 34 | + options[:skip] = %w(api/ng.html guide/tutorial/step_14.html guide/api.html guide/tutorial/.html) | |
| 35 | + options[:skip_patterns] = [ | |
| 36 | + /error\/\$compile/, | |
| 37 | + /misc/, | |
| 38 | + ] | |
| 35 | 39 | |
| 36 | 40 | options[:attribution] = <<-HTML |
| 37 | − © 2010–2017 Google, Inc.<br> | |
| 41 | + © 2010–2018 Google, Inc.<br> | |
| 38 | 42 | Licensed under the Creative Commons Attribution License 4.0. |
| 39 | 43 | HTML |
| 40 | 44 | |
| @@ -45,8 +49,13 @@ module Docs · 4 unmodified lines | ||
| 45 | 49 | capybara.execute_script("return document.querySelector('.side-navigation').innerHTML") |
| 46 | 50 | end |
| 47 | 51 | |
| 52 | + version '1.7' do | |
| 53 | + self.release = '1.7.8' | |
| 54 | + self.base_url = "https://code.angularjs.org/#{release}/docs/partials/" | |
| 55 | + end | |
| 56 | + | |
| 48 | 57 | version '1.6' do |
| 49 | − self.release = '1.6.6' | |
| 58 | + self.release = '1.6.9' | |
| 50 | 59 | self.base_url = "https://code.angularjs.org/#{release}/docs/partials/" |
| 51 | 60 | end |
| 52 | 61 | |
| @@ -69,5 +78,9 @@ module Docs · 16 unmodified lines | ||
| 69 | 78 | self.release = '1.2.32' |
| 70 | 79 | self.base_url = "https://code.angularjs.org/#{release}/docs/partials/" |
| 71 | 80 | end |
| 81 | + | |
| 82 | + def get_latest_version(opts) | |
| 83 | + get_npm_version('angular', opts) | |
| 84 | + end | |
| 72 | 85 | end |
| 73 | 86 | end |
| @@ -11,72 +11,47 @@ module Docs · 10 unmodified lines | ||
| 11 | 11 | |
| 12 | 12 | options[:attribution] = <<-HTML |
| 13 | 13 | © 2012–2018 Michael DeHaan<br> |
| 14 | − © 2018 Red Hat, Inc.<br> | |
| 14 | + © 2018–2019 Red Hat, Inc.<br> | |
| 15 | 15 | Licensed under the GNU General Public License version 3. |
| 16 | 16 | HTML |
| 17 | 17 | |
| 18 | − version '2.7' do | |
| 19 | − self.release = '2.7.1' | |
| 20 | − self.base_url = 'https://docs.ansible.com/ansible/2.7/' | |
| 18 | + options[:skip] = %w( | |
| 19 | + installation_guide/index.html | |
| 20 | + reference_appendices/glossary.html | |
| 21 | + reference_appendices/faq.html | |
| 22 | + reference_appendices/tower.html | |
| 23 | + user_guide/quickstart.html | |
| 24 | + modules/modules_by_category.html | |
| 25 | + modules/list_of_all_modules.html) | |
| 21 | 26 | |
| 22 | − options[:skip] = %w( | |
| 23 | − installation_guide/index.html | |
| 24 | − reference_appendices/glossary.html | |
| 25 | − reference_appendices/faq.html | |
| 26 | − reference_appendices/tower.html | |
| 27 | − user_guide/quickstart.html | |
| 28 | − modules/modules_by_category.html | |
| 29 | − modules/list_of_all_modules.html) | |
| 27 | + options[:skip_patterns] = [ | |
| 28 | + /\Acommunity.*/i, | |
| 29 | + /\Adev_guide.*/i, | |
| 30 | + /\Aroadmap.*/i, | |
| 31 | + ] | |
| 32 | + | |
| 33 | + version '2.8' do | |
| 34 | + self.release = '2.8.3' | |
| 35 | + self.base_url = 'https://docs.ansible.com/ansible/2.7/' | |
| 36 | + end | |
| 30 | 37 | |
| 31 | − options[:skip_patterns] = [ | |
| 32 | − /\Acommunity.*/i, | |
| 33 | − /\Adev_guide.*/i, | |
| 34 | − /\Aroadmap.*/i, | |
| 35 | − ] | |
| 38 | + version '2.7' do | |
| 39 | + self.release = '2.7.12' | |
| 40 | + self.base_url = 'https://docs.ansible.com/ansible/2.7/' | |
| 36 | 41 | end |
| 37 | 42 | |
| 38 | 43 | version '2.6' do |
| 39 | − self.release = '2.6.7' | |
| 44 | + self.release = '2.6.18' | |
| 40 | 45 | self.base_url = 'https://docs.ansible.com/ansible/2.6/' |
| 41 | − | |
| 42 | − options[:skip] = %w( | |
| 43 | − installation_guide/index.html | |
| 44 | − reference_appendices/glossary.html | |
| 45 | − reference_appendices/faq.html | |
| 46 | − reference_appendices/tower.html | |
| 47 | − user_guide/quickstart.html | |
| 48 | − modules/modules_by_category.html | |
| 49 | − modules/list_of_all_modules.html) | |
| 50 | − | |
| 51 | − options[:skip_patterns] = [ | |
| 52 | − /\Acommunity.*/i, | |
| 53 | − /\Adev_guide.*/i, | |
| 54 | − /\Aroadmap.*/i, | |
| 55 | − ] | |
| 56 | 46 | end |
| 57 | 47 | |
| 58 | 48 | version '2.5' do |
| 59 | − self.release = '2.5.3' | |
| 49 | + self.release = '2.5.15' | |
| 60 | 50 | self.base_url = 'https://docs.ansible.com/ansible/2.5/' |
| 61 | − | |
| 62 | − options[:skip] = %w( | |
| 63 | − installation_guide/index.html | |
| 64 | − reference_appendices/glossary.html | |
| 65 | − reference_appendices/faq.html | |
| 66 | − reference_appendices/tower.html | |
| 67 | − user_guide/quickstart.html | |
| 68 | − modules/modules_by_category.html | |
| 69 | − modules/list_of_all_modules.html) | |
| 70 | − | |
| 71 | − options[:skip_patterns] = [ | |
| 72 | − /\Acommunity.*/i, | |
| 73 | − /\Adev_guide.*/i, | |
| 74 | − /\Aroadmap.*/i, | |
| 75 | − ] | |
| 76 | 51 | end |
| 77 | 52 | |
| 78 | 53 | version '2.4' do |
| 79 | − self.release = '2.4.3' | |
| 54 | + self.release = '2.4.6' | |
| 80 | 55 | self.base_url = 'https://docs.ansible.com/ansible/2.4/' |
| 81 | 56 | |
| 82 | 57 | options[:skip] = %w( |
| @@ -86,6 +61,12 @@ module Docs · 3 unmodified lines | ||
| 86 | 61 | tower.html |
| 87 | 62 | quickstart.html |
| 88 | 63 | list_of_all_modules.html) |
| 64 | + options[:skip_patterns] = [] | |
| 65 | + end | |
| 66 | + | |
| 67 | + def get_latest_version(opts) | |
| 68 | + doc = fetch_doc('https://docs.ansible.com/ansible/latest/index.html', opts) | |
| 69 | + doc.at_css('.DocSiteProduct-CurrentVersion').content.strip | |
| 89 | 70 | end |
| 90 | 71 | end |
| 91 | 72 | end |
| @@ -33,5 +33,10 @@ module Docs · 32 unmodified lines | ||
| 33 | 33 | © 2018 The Apache Software Foundation<br> |
| 34 | 34 | Licensed under the Apache License, Version 2.0. |
| 35 | 35 | HTML |
| 36 | + | |
| 37 | + def get_latest_version(opts) | |
| 38 | + doc = fetch_doc('http://httpd.apache.org/docs/', opts) | |
| 39 | + doc.at_css('#apcontents > ul a')['href'][0...-1] | |
| 40 | + end | |
| 36 | 41 | end |
| 37 | 42 | end |
| @@ -43,5 +43,10 @@ module Docs · 42 unmodified lines | ||
| 43 | 43 | self.base_url = "https://pig.apache.org/docs/r#{release}/" |
| 44 | 44 | end |
| 45 | 45 | |
| 46 | + def get_latest_version(opts) | |
| 47 | + doc = fetch_doc('https://pig.apache.org/', opts) | |
| 48 | + item = doc.at_css('div[id="menu_1.2"] > .menuitem:last-child') | |
| 49 | + item.content.strip.sub(/Release /, '') | |
| 50 | + end | |
| 46 | 51 | end |
| 47 | 52 | end |
| @@ -17,5 +17,10 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | © 2010–2018 Caolan McMahon<br> |
| 18 | 18 | Licensed under the MIT License. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + doc = fetch_doc('https://caolan.github.io/async/v3/', opts) | |
| 23 | + doc.at_css('#version-dropdown > a').content.strip[1..-1] | |
| 24 | + end | |
| 20 | 25 | end |
| 21 | 26 | end |
| @@ -22,5 +22,10 @@ module Docs · 21 unmodified lines | ||
| 22 | 22 | stub '' do |
| 23 | 23 | '<div></div>' |
| 24 | 24 | end |
| 25 | + | |
| 26 | + def get_latest_version(opts) | |
| 27 | + doc = fetch_doc('https://babeljs.io/docs/en/', opts) | |
| 28 | + doc.at_css('a[href="/versions"] > h3').content | |
| 29 | + end | |
| 25 | 30 | end |
| 26 | 31 | end |
| @@ -20,5 +20,10 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © 2010–2016 Jeremy Ashkenas, DocumentCloud<br> |
| 21 | 21 | Licensed under the MIT License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + doc = fetch_doc('https://backbonejs.org/', opts) | |
| 26 | + doc.at_css('.version').content[1...-1] | |
| 27 | + end | |
| 23 | 28 | end |
| 24 | 29 | end |
| @@ -1,7 +1,7 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Bash < UrlScraper |
| 3 | 3 | self.type = 'bash' |
| 4 | − self.release = '4.4' | |
| 4 | + self.release = '5.0' | |
| 5 | 5 | self.base_url = 'https://www.gnu.org/software/bash/manual' |
| 6 | 6 | self.root_path = '/html_node/index.html' |
| 7 | 7 | self.links = { |
| @@ -17,5 +17,10 @@ module Docs · 9 unmodified lines | ||
| 17 | 17 | Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.<br> |
| 18 | 18 | Licensed under the GNU Free Documentation License. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + body = fetch('https://www.gnu.org/software/bash/manual/html_node/index.html', opts) | |
| 23 | + body.scan(/, Version ([0-9.]+)/)[0][0][0...-1] | |
| 24 | + end | |
| 20 | 25 | end |
| 21 | 26 | end |
| @@ -18,5 +18,9 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2013–2017 Petka Antonov<br> |
| 19 | 19 | Licensed under the MIT License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + get_npm_version('bluebird', opts) | |
| 24 | + end | |
| 21 | 25 | end |
| 22 | 26 | end |
| @@ -8,16 +8,17 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | |
| 9 | 9 | options[:trailing_slash] = true |
| 10 | 10 | |
| 11 | + # https://github.com/twbs/bootstrap/blob/master/LICENSE | |
| 11 | 12 | options[:attribution] = <<-HTML |
| 12 | − © 2011–2018 Twitter, Inc.<br> | |
| 13 | − © 2011–2018 The Bootstrap Authors<br> | |
| 13 | + © 2011–2019 Twitter, Inc.<br> | |
| 14 | + © 2011–2019 The Bootstrap Authors<br> | |
| 14 | 15 | Code licensed under the MIT License.<br> |
| 15 | 16 | Documentation licensed under the Creative Commons Attribution License v3.0. |
| 16 | 17 | HTML |
| 17 | 18 | |
| 18 | 19 | version '4' do |
| 19 | − self.release = '4.1.3' | |
| 20 | − self.base_url = 'https://getbootstrap.com/docs/4.1/' | |
| 20 | + self.release = '4.3.1' | |
| 21 | + self.base_url = 'https://getbootstrap.com/docs/4.3/' | |
| 21 | 22 | self.root_path = 'getting-started/introduction/' |
| 22 | 23 | |
| 23 | 24 | html_filters.push 'bootstrap/entries_v4', 'bootstrap/clean_html_v4' |
| @@ -34,5 +35,10 @@ module Docs · 10 unmodified lines | ||
| 34 | 35 | |
| 35 | 36 | options[:only] = %w(getting-started/ css/ components/ javascript/) |
| 36 | 37 | end |
| 38 | + | |
| 39 | + def get_latest_version(opts) | |
| 40 | + doc = fetch_doc('https://getbootstrap.com/', opts) | |
| 41 | + doc.at_css('#bd-versions').content.strip[1..-1] | |
| 42 | + end | |
| 37 | 43 | end |
| 38 | 44 | end |
| @@ -27,5 +27,11 @@ module Docs · 26 unmodified lines | ||
| 27 | 27 | self.release = '0.11.7' |
| 28 | 28 | self.base_url = "https://bottlepy.org/docs/#{self.version}/" |
| 29 | 29 | end |
| 30 | + | |
| 31 | + def get_latest_version(opts) | |
| 32 | + doc = fetch_doc('https://bottlepy.org/docs/stable/', opts) | |
| 33 | + label = doc.at_css('.sphinxsidebarwrapper > ul > li > b') | |
| 34 | + label.content.sub(/Bottle /, '') | |
| 35 | + end | |
| 30 | 36 | end |
| 31 | 37 | end |
| @@ -19,5 +19,9 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2018 Bower contributors<br> |
| 20 | 20 | Licensed under the MIT License. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_npm_version('bower', opts) | |
| 25 | + end | |
| 22 | 26 | end |
| 23 | 27 | end |
| @@ -26,6 +26,13 @@ module Docs · 25 unmodified lines | ||
| 26 | 26 | Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. |
| 27 | 27 | HTML |
| 28 | 28 | |
| 29 | + def get_latest_version(opts) | |
| 30 | + doc = fetch_doc('https://en.cppreference.com/w/Cppreference:Archives', opts) | |
| 31 | + link = doc.at_css('a[title^="File:"]') | |
| 32 | + date = link.content.scan(/(\d+)\./)[0][0] | |
| 33 | + DateTime.strptime(date, '%Y%m%d').to_time.to_i | |
| 34 | + end | |
| 35 | + | |
| 29 | 36 | private |
| 30 | 37 | |
| 31 | 38 | def file_path_for(*) |
| @@ -71,6 +71,11 @@ module Docs · 70 unmodified lines | ||
| 71 | 71 | self.base_url = 'https://api.cakephp.org/2.7/' |
| 72 | 72 | end |
| 73 | 73 | |
| 74 | + def get_latest_version(opts) | |
| 75 | + doc = fetch_doc('https://api.cakephp.org/3.7/', opts) | |
| 76 | + doc.at_css('.version-picker .dropdown-toggle').content.strip | |
| 77 | + end | |
| 78 | + | |
| 74 | 79 | private |
| 75 | 80 | |
| 76 | 81 | def parse(response) |
| @@ -23,5 +23,9 @@ module Docs · 22 unmodified lines | ||
| 23 | 23 | © 2016 Chai.js Assertion Library<br> |
| 24 | 24 | Licensed under the MIT License. |
| 25 | 25 | HTML |
| 26 | + | |
| 27 | + def get_latest_version(opts) | |
| 28 | + get_npm_version('chai', opts) | |
| 29 | + end | |
| 26 | 30 | end |
| 27 | 31 | end |
| @@ -47,5 +47,10 @@ module Docs · 46 unmodified lines | ||
| 47 | 47 | |
| 48 | 48 | options[:only_patterns] = [/\A#{client_path}\//, /\A#{server_path}\//] |
| 49 | 49 | end |
| 50 | + | |
| 51 | + def get_latest_version(opts) | |
| 52 | + doc = fetch_doc('https://downloads.chef.io/chef', opts) | |
| 53 | + doc.at_css('h1.product-heading > span').content.strip | |
| 54 | + end | |
| 50 | 55 | end |
| 51 | 56 | end |
| @@ -13,19 +13,29 @@ module Docs · 12 unmodified lines | ||
| 13 | 13 | Licensed under the Eclipse Public License 1.0. |
| 14 | 14 | HTML |
| 15 | 15 | |
| 16 | − version '1.9' do | |
| 17 | − self.release = '1.9' | |
| 16 | + version '1.10' do | |
| 17 | + self.release = '1.10 (stable)' | |
| 18 | 18 | self.base_url = 'https://clojure.github.io/clojure/' |
| 19 | 19 | end |
| 20 | 20 | |
| 21 | + version '1.9' do | |
| 22 | + self.release = '1.9 (legacy)' | |
| 23 | + self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.9.0/' | |
| 24 | + end | |
| 25 | + | |
| 21 | 26 | version '1.8' do |
| 22 | − self.release = '1.8' | |
| 27 | + self.release = '1.8 (legacy)' | |
| 23 | 28 | self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.8.0/' |
| 24 | 29 | end |
| 25 | 30 | |
| 26 | 31 | version '1.7' do |
| 27 | − self.release = '1.7' | |
| 32 | + self.release = '1.7 (legacy)' | |
| 28 | 33 | self.base_url = 'https://clojure.github.io/clojure/branch-clojure-1.7.0/' |
| 29 | 34 | end |
| 35 | + | |
| 36 | + def get_latest_version(opts) | |
| 37 | + doc = fetch_doc('http://clojure.github.io/clojure/index.html', opts) | |
| 38 | + doc.at_css('#header-version').content[1..-1] | |
| 39 | + end | |
| 30 | 40 | end |
| 31 | 41 | end |
| @@ -13,51 +13,72 @@ module Docs · 12 unmodified lines | ||
| 13 | 13 | options[:title] = false |
| 14 | 14 | options[:root_title] = 'CMake Reference Documentation' |
| 15 | 15 | options[:skip] = %w(release/index.html genindex.html search.html) |
| 16 | − options[:skip_patterns] = [/\Agenerator/, /\Ainclude/, /\Arelease/] | |
| 16 | + options[:skip_patterns] = [/\Agenerator/, /\Acpack_gen/, /\Ainclude/, /\Arelease/] | |
| 17 | 17 | |
| 18 | 18 | options[:attribution] = <<-HTML |
| 19 | − © 2000–2018 Kitware, Inc. and Contributors<br> | |
| 19 | + © 2000–2019 Kitware, Inc. and Contributors<br> | |
| 20 | 20 | Licensed under the BSD 3-clause License. |
| 21 | 21 | HTML |
| 22 | 22 | |
| 23 | + version '3.15' do | |
| 24 | + self.release = '3.15.2' | |
| 25 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 26 | + end | |
| 27 | + | |
| 28 | + version '3.14' do | |
| 29 | + self.release = '3.14.6' | |
| 30 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 31 | + end | |
| 32 | + | |
| 33 | + version '3.13' do | |
| 34 | + self.release = '3.13.5' | |
| 35 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 36 | + end | |
| 37 | + | |
| 23 | 38 | version '3.12' do |
| 24 | − self.release = '3.12.1' | |
| 25 | − self.base_url = 'https://cmake.org/cmake/help/v3.12/' | |
| 39 | + self.release = '3.12.4' | |
| 40 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 26 | 41 | end |
| 27 | 42 | |
| 28 | 43 | version '3.11' do |
| 29 | 44 | self.release = '3.11.4' |
| 30 | − self.base_url = 'https://cmake.org/cmake/help/v3.11/' | |
| 45 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 31 | 46 | end |
| 32 | 47 | |
| 33 | 48 | version '3.10' do |
| 34 | 49 | self.release = '3.10.3' |
| 35 | − self.base_url = 'https://cmake.org/cmake/help/v3.10/' | |
| 50 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 36 | 51 | end |
| 37 | 52 | |
| 38 | 53 | version '3.9' do |
| 39 | 54 | self.release = '3.9.6' |
| 40 | − self.base_url = 'https://cmake.org/cmake/help/v3.9/' | |
| 55 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 41 | 56 | end |
| 42 | 57 | |
| 43 | 58 | version '3.8' do |
| 44 | 59 | self.release = '3.8.2' |
| 45 | − self.base_url = 'https://cmake.org/cmake/help/v3.8/' | |
| 60 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 46 | 61 | end |
| 47 | 62 | |
| 48 | 63 | version '3.7' do |
| 49 | 64 | self.release = '3.7.2' |
| 50 | − self.base_url = 'https://cmake.org/cmake/help/v3.7/' | |
| 65 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 51 | 66 | end |
| 52 | 67 | |
| 53 | 68 | version '3.6' do |
| 54 | 69 | self.release = '3.6.3' |
| 55 | − self.base_url = 'https://cmake.org/cmake/help/v3.6/' | |
| 70 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 56 | 71 | end |
| 57 | 72 | |
| 58 | 73 | version '3.5' do |
| 59 | 74 | self.release = '3.5.2' |
| 60 | − self.base_url = 'https://cmake.org/cmake/help/v3.5/' | |
| 75 | + self.base_url = "https://cmake.org/cmake/help/v#{self.version}/" | |
| 76 | + end | |
| 77 | + | |
| 78 | + def get_latest_version(opts) | |
| 79 | + doc = fetch_doc('https://cmake.org/documentation/', opts) | |
| 80 | + link = doc.at_css('.entry-content ul > li > strong > a > big') | |
| 81 | + link.content.scan(/([0-9.]+)/)[0][0] | |
| 61 | 82 | end |
| 62 | 83 | end |
| 63 | 84 | end |
| @@ -18,5 +18,10 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2011 Michael Bodnarchuk and contributors<br> |
| 19 | 19 | Licensed under the MIT License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + doc = fetch_doc('https://codeception.com/changelog', opts) | |
| 24 | + doc.at_css('#page > h4').content | |
| 25 | + end | |
| 21 | 26 | end |
| 22 | 27 | end |
| @@ -21,5 +21,9 @@ module Docs · 20 unmodified lines | ||
| 21 | 21 | © 2015 DavertMik <davert@codegyre.com> (http://codegyre.com)<br> |
| 22 | 22 | Licensed under the MIT License. |
| 23 | 23 | HTML |
| 24 | + | |
| 25 | + def get_latest_version(opts) | |
| 26 | + get_npm_version('codeceptjs', opts) | |
| 27 | + end | |
| 24 | 28 | end |
| 25 | 29 | end |
| @@ -38,5 +38,11 @@ module Docs · 37 unmodified lines | ||
| 38 | 38 | version '3' do |
| 39 | 39 | self.release = '3.1.8' |
| 40 | 40 | end |
| 41 | + | |
| 42 | + def get_latest_version(opts) | |
| 43 | + doc = fetch_doc('https://codeigniter.com/user_guide/changelog.html', opts) | |
| 44 | + header = doc.at_css('#change-log h2') | |
| 45 | + header.content.scan(/([0-9.]+)/)[0][0] | |
| 46 | + end | |
| 41 | 47 | end |
| 42 | 48 | end |
| @@ -30,5 +30,9 @@ module Docs · 29 unmodified lines | ||
| 30 | 30 | |
| 31 | 31 | options[:container] = '.container' |
| 32 | 32 | end |
| 33 | + | |
| 34 | + def get_latest_version(opts) | |
| 35 | + get_npm_version('coffeescript', opts) | |
| 36 | + end | |
| 33 | 37 | end |
| 34 | 38 | end |
| @@ -0,0 +1,28 @@ | ||
| 1 | +module Docs | |
| 2 | + class Composer < UrlScraper | |
| 3 | + self.type = 'simple' | |
| 4 | + self.release = '1.9.0' | |
| 5 | + self.base_url = 'https://getcomposer.org/doc/' | |
| 6 | + self.links = { | |
| 7 | + home: 'https://getcomposer.org', | |
| 8 | + code: 'https://github.com/composer/composer' | |
| 9 | + } | |
| 10 | + | |
| 11 | + html_filters.push 'composer/clean_html', 'composer/entries' | |
| 12 | + | |
| 13 | + options[:container] = '#main' | |
| 14 | + | |
| 15 | + options[:skip_patterns] = [ | |
| 16 | + /^faqs/ | |
| 17 | + ] | |
| 18 | + | |
| 19 | + options[:attribution] = <<-HTML | |
| 20 | + © Nils Adermann, Jordi Boggiano<br> | |
| 21 | + Licensed under the MIT License. | |
| 22 | + HTML | |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + get_latest_github_release('composer', 'composer', opts) | |
| 26 | + end | |
| 27 | + end | |
| 28 | +end | |
| @@ -42,5 +42,15 @@ module Docs · 41 unmodified lines | ||
| 42 | 42 | self.release = '6.5.0' |
| 43 | 43 | self.base_url = 'https://cordova.apache.org/docs/en/6.x/' |
| 44 | 44 | end |
| 45 | + | |
| 46 | + def get_latest_version(opts) | |
| 47 | + doc = fetch_doc('https://cordova.apache.org/docs/en/latest/', opts) | |
| 48 | + | |
| 49 | + label = doc.at_css('#versionDropdown').content.strip | |
| 50 | + version = label.scan(/([0-9.]+)/)[0][0] | |
| 51 | + version = version[0...-1] if version.end_with?('.') | |
| 52 | + | |
| 53 | + version | |
| 54 | + end | |
| 45 | 55 | end |
| 46 | 56 | end |
| @@ -34,6 +34,14 @@ module Docs · 33 unmodified lines | ||
| 34 | 34 | Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. |
| 35 | 35 | HTML |
| 36 | 36 | |
| 37 | + # Same as get_latest_version in lib/docs/scrapers/c.rb | |
| 38 | + def get_latest_version(opts) | |
| 39 | + doc = fetch_doc('https://en.cppreference.com/w/Cppreference:Archives', opts) | |
| 40 | + link = doc.at_css('a[title^="File:"]') | |
| 41 | + date = link.content.scan(/(\d+)\./)[0][0] | |
| 42 | + DateTime.strptime(date, '%Y%m%d').to_time.to_i | |
| 43 | + end | |
| 44 | + | |
| 37 | 45 | private |
| 38 | 46 | |
| 39 | 47 | def file_path_for(*) |
| @@ -34,5 +34,10 @@ module Docs · 33 unmodified lines | ||
| 34 | 34 | HTML |
| 35 | 35 | end |
| 36 | 36 | } |
| 37 | + | |
| 38 | + def get_latest_version(opts) | |
| 39 | + body = fetch('https://crystal-lang.org/api', opts) | |
| 40 | + body.scan(/Crystal Docs ([0-9.]+)/)[0][0] | |
| 41 | + end | |
| 37 | 42 | end |
| 38 | 43 | end |
| @@ -0,0 +1,36 @@ | ||
| 1 | +# frozen_string_literal: true | |
| 2 | + | |
| 3 | +module Docs | |
| 4 | + class Cypress < UrlScraper | |
| 5 | + self.name = 'Cypress' | |
| 6 | + self.type = 'cypress' | |
| 7 | + self.release = '3.4.1' | |
| 8 | + self.base_url = 'https://docs.cypress.io' | |
| 9 | + self.root_path = '/api/api/table-of-contents.html' | |
| 10 | + self.links = { | |
| 11 | + home: 'https://www.cypress.io/', | |
| 12 | + code: 'https://github.com/cypress-io/cypress', | |
| 13 | + } | |
| 14 | + | |
| 15 | + html_filters.push 'cypress/entries', 'cypress/clean_html' | |
| 16 | + | |
| 17 | + options[:container] = '#content' | |
| 18 | + options[:max_image_size] = 300_000 | |
| 19 | + options[:include_default_entry] = true | |
| 20 | + | |
| 21 | + options[:skip_patterns] = [/examples\//] | |
| 22 | + options[:skip_link] = ->(link) { | |
| 23 | + href = link.attr(:href) | |
| 24 | + href.nil? ? true : EntriesFilter::SECTIONS.none? { |section| href.match?("/#{section}/") } | |
| 25 | + } | |
| 26 | + | |
| 27 | + options[:attribution] = <<-HTML | |
| 28 | + © 2017 Cypress.io<br> | |
| 29 | + Licensed under the MIT License. | |
| 30 | + HTML | |
| 31 | + | |
| 32 | + def get_latest_version(opts) | |
| 33 | + get_latest_github_release('cypress-io', 'cypress', opts) | |
| 34 | + end | |
| 35 | + end | |
| 36 | +end | |
| @@ -26,5 +26,10 @@ module Docs · 25 unmodified lines | ||
| 26 | 26 | def initial_urls |
| 27 | 27 | %w(https://dlang.org/phobos/index.html https://dlang.org/spec/intro.html) |
| 28 | 28 | end |
| 29 | + | |
| 30 | + def get_latest_version(opts) | |
| 31 | + doc = fetch_doc('https://dlang.org/changelog/', opts) | |
| 32 | + doc.at_css('#content > ul > li:nth-child(2) > a')['id'] | |
| 33 | + end | |
| 29 | 34 | end |
| 30 | 35 | end |
| @@ -58,5 +58,9 @@ module Docs · 57 unmodified lines | ||
| 58 | 58 | options[:root_title] = 'D3.js' |
| 59 | 59 | options[:only_patterns] = [/\.md\z/] |
| 60 | 60 | end |
| 61 | + | |
| 62 | + def get_latest_version(opts) | |
| 63 | + get_npm_version('d3', opts) | |
| 64 | + end | |
| 61 | 65 | end |
| 62 | 66 | end |
| @@ -31,5 +31,11 @@ module Docs · 30 unmodified lines | ||
| 31 | 31 | self.release = '1.24.3' |
| 32 | 32 | self.base_url = "https://api.dartlang.org/stable/#{release}/" |
| 33 | 33 | end |
| 34 | + | |
| 35 | + def get_latest_version(opts) | |
| 36 | + doc = fetch_doc('https://api.dartlang.org/', opts) | |
| 37 | + label = doc.at_css('footer > span').content.strip | |
| 38 | + label.sub(/Dart /, '') | |
| 39 | + end | |
| 34 | 40 | end |
| 35 | 41 | end |
| @@ -34,18 +34,23 @@ module Docs · 33 unmodified lines | ||
| 34 | 34 | Licensed under the BSD License. |
| 35 | 35 | HTML |
| 36 | 36 | |
| 37 | + version '2.2' do | |
| 38 | + self.release = '2.2.4' | |
| 39 | + self.base_url = 'https://docs.djangoproject.com/en/2.2/' | |
| 40 | + end | |
| 41 | + | |
| 37 | 42 | version '2.1' do |
| 38 | − self.release = '2.1.0' | |
| 43 | + self.release = '2.1.11' | |
| 39 | 44 | self.base_url = 'https://docs.djangoproject.com/en/2.1/' |
| 40 | 45 | end |
| 41 | 46 | |
| 42 | 47 | version '2.0' do |
| 43 | − self.release = '2.0.7' | |
| 48 | + self.release = '2.0.13' | |
| 44 | 49 | self.base_url = 'https://docs.djangoproject.com/en/2.0/' |
| 45 | 50 | end |
| 46 | 51 | |
| 47 | 52 | version '1.11' do |
| 48 | − self.release = '1.11.9' | |
| 53 | + self.release = '1.11.23' | |
| 49 | 54 | self.base_url = 'https://docs.djangoproject.com/en/1.11/' |
| 50 | 55 | end |
| 51 | 56 | |
| @@ -63,5 +68,10 @@ module Docs · 11 unmodified lines | ||
| 63 | 68 | self.release = '1.8.18' |
| 64 | 69 | self.base_url = 'https://docs.djangoproject.com/en/1.8/' |
| 65 | 70 | end |
| 71 | + | |
| 72 | + def get_latest_version(opts) | |
| 73 | + doc = fetch_doc('https://docs.djangoproject.com/', opts) | |
| 74 | + doc.at_css('#doc-versions > li.current > span > strong').content | |
| 75 | + end | |
| 66 | 76 | end |
| 67 | 77 | end |
| @@ -15,15 +15,15 @@ module Docs · 14 unmodified lines | ||
| 15 | 15 | end |
| 16 | 16 | |
| 17 | 17 | options[:attribution] = <<-HTML |
| 18 | − © 2017 Docker, Inc.<br> | |
| 18 | + © 2019 Docker, Inc.<br> | |
| 19 | 19 | Licensed under the Apache License, Version 2.0.<br> |
| 20 | 20 | Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br> |
| 21 | 21 | Docker, Inc. and other parties may also have trademark rights in other terms used herein. |
| 22 | 22 | HTML |
| 23 | 23 | |
| 24 | − version '17' do | |
| 25 | − self.release = '17.06' | |
| 26 | − self.base_url = 'https://docs.docker.com/' | |
| 24 | + version '19' do | |
| 25 | + self.release = '19.03' | |
| 26 | + self.base_url = "https://docs.docker.com/" | |
| 27 | 27 | |
| 28 | 28 | html_filters.push 'docker/entries', 'docker/clean_html' |
| 29 | 29 | |
| @@ -33,29 +33,150 @@ module Docs · 3 unmodified lines | ||
| 33 | 33 | options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/] |
| 34 | 34 | |
| 35 | 35 | options[:replace_paths] = { |
| 36 | − 'engine/installation/linux/docker-ee/linux-postinstall/' => 'engine/installation/linux/linux-postinstall/', | |
| 37 | − 'engine/installation/linux/docker-ee/' => 'engine/installation/', | |
| 38 | − 'engine/installation/linux/docker-ce/' => 'engine/installation/', | |
| 39 | − 'engine/installation/linux/' => 'engine/installation/', | |
| 40 | − 'engine/installation/windows/' => 'engine/installation/', | |
| 41 | − 'engine/userguide/intro/' => 'engine/userguide/', | |
| 42 | − 'engine/tutorials/dockervolumes/' => 'engine/admin/volumes/volumes/', | |
| 43 | − 'engine/getstarted/' => 'get-started/', | |
| 44 | − 'engine/tutorials/dockerimages/' => 'get-started/', | |
| 45 | − 'engine/tutorials/dockerrepos/' => 'get-started/', | |
| 46 | − 'engine/admin/host_integration/' => 'engine/admin/start-containers-automatically/', | |
| 47 | − 'engine/installation/linux/rhel/' => 'engine/installation/linux/docker-ee/rhel/', | |
| 48 | − 'engine/installation/linux/ubuntulinux/' => 'engine/installation/linux/docker-ee/ubuntu/', | |
| 49 | − 'engine/installation/linux/suse/' => 'engine/installation/linux/docker-ee/suse/', | |
| 50 | − 'engine/admin/logging/' => 'engine/admin/logging/view_container_logs/', | |
| 51 | − 'engine/swarm/how-swarm-mode-works/' => 'engine/swarm/how-swarm-mode-works/nodes/', | |
| 52 | − 'engine/installation/binaries/' => 'engine/installation/linux/docker-ce/binaries/', | |
| 36 | + 'install/linux/ubuntu/' => 'install/linux/docker-ce', | |
| 37 | + 'get-started/part1' => 'get-started', | |
| 38 | + 'engine/installation/' => 'install', | |
| 39 | + 'engine/installation/linux/linux-postinstall/' => 'install/linux', | |
| 40 | + 'compose/overview/' => 'compose', | |
| 41 | + 'docker-cloud/' => 'docker-hub', | |
| 42 | + 'datacenter/install/linux/' => 'ee', | |
| 43 | + 'engine/userguide/' => 'config/daemon', | |
| 44 | + 'engine/admin/' => 'config/daemon', | |
| 45 | + 'opensource/get-help/' => 'opensource', | |
| 46 | + 'engine/tutorials/dockerimages/' => 'get-started', | |
| 47 | + 'engine/admin/volumes/bind-mounts/' => 'storage', | |
| 48 | + 'engine/tutorials/dockervolumes/' => 'storage', | |
| 49 | + 'engine/admin/volumes/volumes/' => 'storage', | |
| 50 | + 'engine/userguide/labels-custom-metadata/' => 'config', | |
| 51 | + 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images', | |
| 52 | + 'engine/swarm/networking/' => 'network', | |
| 53 | + 'engine/admin/resource_constraints/' => 'config/containers', | |
| 54 | + 'engine/admin/logging/overview/' => 'config/containers/logging', | |
| 55 | + 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images', | |
| 56 | + 'engine/tutorials/dockerrepos/' => 'get-started', | |
| 57 | + 'engine/userguide/networking/' => 'network', | |
| 58 | + 'engine/userguide/networking/get-started-overlay/' => 'network', | |
| 59 | + 'engine/reference/commandline/swarm_join_token/' => 'engine/reference/commandline', | |
| 60 | + 'engine/understanding-docker/' => 'engine', | |
| 61 | + 'engine/userguide/dockervolumes/' => 'storage', | |
| 62 | + 'engine/installation/binaries/' => 'install/linux/docker-ce', | |
| 63 | + 'engine/userguide/networking/default_network/dockerlinks/' => 'network', | |
| 64 | + 'engine/reference/api/' => 'develop/sdk', | |
| 65 | + 'engine/admin/systemd/' => 'config/daemon', | |
| 66 | + 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver', | |
| 67 | + 'engine/api/' => 'develop/sdk', | |
| 68 | + 'engine/userguide/networking/get-started-overlay' => 'network', | |
| 69 | + 'engine/userguide/networking/overlay-security-model/' => 'network', | |
| 70 | + 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce', | |
| 71 | + 'engine/admin/volumes/' => 'storage/volumes/', | |
| 72 | + 'engine/userguide/networking//' => 'network', | |
| 73 | + 'engine/reference/commandline' => 'engine/reference/commandline/docker', | |
| 53 | 74 | 'engine/reference/commandline/' => 'engine/reference/commandline/docker/', |
| 54 | − 'engine/reference/api/' => 'engine/api/', | |
| 55 | − 'engine/userguide/dockervolumes/' => 'engine/admin/volumes/volumes/', | |
| 56 | − 'engine/understanding-docker/' => 'engine/docker-overview/', | |
| 57 | − 'engine/reference/commandline/swarm_join_token/' => 'engine/reference/commandline/swarm_join-token/', | |
| 58 | − 'engine/api/getting-started/' => 'engine/api/get-started/', | |
| 75 | + } | |
| 76 | + end | |
| 77 | + | |
| 78 | + version '18' do | |
| 79 | + self.release = '18.09' | |
| 80 | + self.base_url = "https://docs.docker.com/v#{release}/" | |
| 81 | + | |
| 82 | + html_filters.push 'docker/entries', 'docker/clean_html' | |
| 83 | + | |
| 84 | + options[:container] = '.wrapper .container-fluid .row' | |
| 85 | + | |
| 86 | + options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//] | |
| 87 | + options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/] | |
| 88 | + | |
| 89 | + options[:replace_paths] = { | |
| 90 | + 'install/linux/ubuntu/' => 'install/linux/docker-ce', | |
| 91 | + 'get-started/part1' => 'get-started', | |
| 92 | + 'engine/installation/' => 'install', | |
| 93 | + 'engine/installation/linux/linux-postinstall/' => 'install/linux', | |
| 94 | + 'compose/overview/' => 'compose', | |
| 95 | + 'datacenter/install/linux/' => 'ee', | |
| 96 | + 'engine/userguide/' => 'config/daemon', | |
| 97 | + 'engine/admin/' => 'config/daemon', | |
| 98 | + 'opensource/get-help/' => 'opensource', | |
| 99 | + 'engine/tutorials/dockerimages/' => 'get-started', | |
| 100 | + 'engine/admin/volumes/bind-mounts/' => 'storage', | |
| 101 | + 'engine/tutorials/dockervolumes/' => 'storage', | |
| 102 | + 'engine/admin/volumes/volumes/' => 'storage', | |
| 103 | + 'engine/userguide/labels-custom-metadata/' => 'config', | |
| 104 | + 'engine/reference/api/' => 'develop/sdk', | |
| 105 | + 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images', | |
| 106 | + 'engine/swarm/networking/' => 'network', | |
| 107 | + 'engine/admin/resource_constraints/' => 'config/containers', | |
| 108 | + 'engine/admin/logging/overview/' => 'config/containers/logging', | |
| 109 | + 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images', | |
| 110 | + 'engine/tutorials/dockerrepos/' => 'get-started', | |
| 111 | + 'engine/userguide/networking/' => 'network', | |
| 112 | + 'engine/userguide/networking/get-started-overlay/' => 'network', | |
| 113 | + 'engine/understanding-docker/' => 'engine', | |
| 114 | + 'engine/reference/commandline/swarm_join_token/' => 'engine/reference/commandline', | |
| 115 | + 'engine/userguide/dockervolumes/' => 'storage', | |
| 116 | + 'engine/admin/systemd/' => 'config/daemon', | |
| 117 | + 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver', | |
| 118 | + 'engine/installation/binaries/' => 'install/linux/docker-ce', | |
| 119 | + 'engine/userguide/networking/default_network/dockerlinks/' => 'network', | |
| 120 | + 'engine/userguide/networking/overlay-security-model/' => 'network', | |
| 121 | + 'engine/userguide/networking/get-started-overlay' => 'network', | |
| 122 | + 'engine/api/' => 'develop/sdk', | |
| 123 | + 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce', | |
| 124 | + 'engine/admin/volumes/' => 'storage/volumes/', | |
| 125 | + 'engine/userguide/networking//' => 'network', | |
| 126 | + 'engine/reference/commandline' => 'engine/reference/commandline/docker', | |
| 127 | + 'engine/reference/commandline/' => 'engine/reference/commandline/docker/', | |
| 128 | + } | |
| 129 | + end | |
| 130 | + | |
| 131 | + version '17' do | |
| 132 | + self.release = '17.12' | |
| 133 | + self.base_url = "https://docs.docker.com/v#{release}/" | |
| 134 | + | |
| 135 | + html_filters.push 'docker/entries', 'docker/clean_html' | |
| 136 | + | |
| 137 | + options[:container] = '.wrapper .container-fluid .row' | |
| 138 | + | |
| 139 | + options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//] | |
| 140 | + options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/] | |
| 141 | + | |
| 142 | + options[:replace_paths] = { | |
| 143 | + 'get-started/part1' => 'get-started', | |
| 144 | + 'engine/installation/' => 'install', | |
| 145 | + 'engine/installation/linux/linux-postinstall/' => 'install/linux', | |
| 146 | + 'opensource/get-help/' => 'opensource', | |
| 147 | + 'engine/admin/volumes/volumes/' => 'storage', | |
| 148 | + 'engine/tutorials/dockerimages/' => 'get-started', | |
| 149 | + 'engine/admin/volumes/bind-mounts/' => 'storage', | |
| 150 | + 'engine/tutorials/dockervolumes/' => 'storage', | |
| 151 | + 'datacenter/install/aws/' => 'docker-for-aws', | |
| 152 | + 'engine/userguide/' => 'config/daemon', | |
| 153 | + 'engine/admin/' => 'config/daemon', | |
| 154 | + 'engine/userguide/labels-custom-metadata/' => 'config', | |
| 155 | + 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images', | |
| 156 | + 'engine/swarm/networking/' => 'network', | |
| 157 | + 'engine/admin/resource_constraints/' => 'config/containers', | |
| 158 | + 'engine/admin/logging/overview/' => 'config/containers/logging', | |
| 159 | + 'engine/understanding-docker/' => 'engine', | |
| 160 | + 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images', | |
| 161 | + 'engine/tutorials/dockerrepos/' => 'get-started', | |
| 162 | + 'engine/userguide/networking/' => 'network', | |
| 163 | + 'engine/reference/commandline/swarm_join_token/' => 'edge/engine/reference/commandline', | |
| 164 | + 'engine/userguide/networking/get-started-overlay/' => 'network', | |
| 165 | + 'engine/userguide/dockervolumes/' => 'storage', | |
| 166 | + 'engine/installation/binaries/' => 'install/linux/docker-ce', | |
| 167 | + 'engine/userguide/networking/default_network/dockerlinks/' => 'network', | |
| 168 | + 'engine/reference/api/' => 'develop/sdk', | |
| 169 | + 'engine/admin/live-restore/' => 'config/containers', | |
| 170 | + 'engine/api/' => 'develop/sdk', | |
| 171 | + 'engine/userguide/networking/get-started-overlay' => 'network', | |
| 172 | + 'security/security/' => 'engine/security', | |
| 173 | + 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce', | |
| 174 | + 'engine/reference/commandline/' => 'edge/engine/reference/commandline', | |
| 175 | + 'engine/admin/systemd/' => 'config/daemon', | |
| 176 | + 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver', | |
| 177 | + 'engine/userguide/networking/overlay-security-model/' => 'network', | |
| 178 | + 'engine/admin/volumes/' => 'storage/volumes/', | |
| 179 | + 'engine/userguide/networking//' => 'network', | |
| 59 | 180 | } |
| 60 | 181 | end |
| 61 | 182 | |
| @@ -137,5 +258,11 @@ module Docs · 75 unmodified lines | ||
| 137 | 258 | options[:container] = '#docs' |
| 138 | 259 | options[:only_patterns] << /\Aswarm\// |
| 139 | 260 | end |
| 261 | + | |
| 262 | + def get_latest_version(opts) | |
| 263 | + doc = fetch_doc('https://docs.docker.com/', opts) | |
| 264 | + label = doc.at_css('.nav-container button.dropdown-toggle').content.strip | |
| 265 | + label.scan(/([0-9.]+)/)[0][0] | |
| 266 | + end | |
| 140 | 267 | end |
| 141 | 268 | end |
| @@ -36,6 +36,11 @@ module Docs · 35 unmodified lines | ||
| 36 | 36 | urls.map { |url| "<a href='#{url}'>#{url}</a>" }.join |
| 37 | 37 | end |
| 38 | 38 | |
| 39 | + def get_latest_version(opts) | |
| 40 | + doc = fetch_doc('https://dojotoolkit.org/api/', opts) | |
| 41 | + doc.at_css('#versionSelector > option[selected]').content | |
| 42 | + end | |
| 43 | + | |
| 39 | 44 | private |
| 40 | 45 | |
| 41 | 46 | def get_url_list(json, set = Set.new) |
| @@ -98,5 +98,10 @@ module Docs · 97 unmodified lines | ||
| 98 | 98 | /\A[\w\-\.]+\.php\/7\.x\z/ |
| 99 | 99 | ] |
| 100 | 100 | end |
| 101 | + | |
| 102 | + def get_latest_version(opts) | |
| 103 | + json = fetch_json('https://packagist.org/packages/drupal/drupal.json', opts) | |
| 104 | + json['package']['versions'].keys.find {|version| !version.end_with?('-dev')} | |
| 105 | + end | |
| 101 | 106 | end |
| 102 | 107 | end |
| @@ -22,5 +22,10 @@ module Docs · 21 unmodified lines | ||
| 22 | 22 | © 2013–2018 GitHub Inc.<br> |
| 23 | 23 | Licensed under the MIT license. |
| 24 | 24 | HTML |
| 25 | + | |
| 26 | + def get_latest_version(opts) | |
| 27 | + doc = fetch_doc('https://electronjs.org/docs', opts) | |
| 28 | + doc.at_css('.docs-version').content | |
| 29 | + end | |
| 25 | 30 | end |
| 26 | 31 | end |
| @@ -33,8 +33,34 @@ module Docs · 32 unmodified lines | ||
| 33 | 33 | "https://elixir-lang.org/getting-started/introduction.html" ] |
| 34 | 34 | end |
| 35 | 35 | |
| 36 | + version '1.9' do | |
| 37 | + self.release = '1.9.1' | |
| 38 | + self.base_urls = [ | |
| 39 | + "https://hexdocs.pm/elixir/#{release}/", | |
| 40 | + "https://hexdocs.pm/eex/#{release}/", | |
| 41 | + "https://hexdocs.pm/ex_unit/#{release}/", | |
| 42 | + "https://hexdocs.pm/iex/#{release}/", | |
| 43 | + "https://hexdocs.pm/logger/#{release}/", | |
| 44 | + "https://hexdocs.pm/mix/#{release}/", | |
| 45 | + 'https://elixir-lang.org/getting-started/' | |
| 46 | + ] | |
| 47 | + end | |
| 48 | + | |
| 49 | + version '1.8' do | |
| 50 | + self.release = '1.8.2' | |
| 51 | + self.base_urls = [ | |
| 52 | + "https://hexdocs.pm/elixir/#{release}/", | |
| 53 | + "https://hexdocs.pm/eex/#{release}/", | |
| 54 | + "https://hexdocs.pm/ex_unit/#{release}/", | |
| 55 | + "https://hexdocs.pm/iex/#{release}/", | |
| 56 | + "https://hexdocs.pm/logger/#{release}/", | |
| 57 | + "https://hexdocs.pm/mix/#{release}/", | |
| 58 | + 'https://elixir-lang.org/getting-started/' | |
| 59 | + ] | |
| 60 | + end | |
| 61 | + | |
| 36 | 62 | version '1.7' do |
| 37 | − self.release = '1.7.3' | |
| 63 | + self.release = '1.7.4' | |
| 38 | 64 | self.base_urls = [ |
| 39 | 65 | "https://hexdocs.pm/elixir/#{release}/", |
| 40 | 66 | "https://hexdocs.pm/eex/#{release}/", |
| @@ -47,7 +73,7 @@ module Docs · 6 unmodified lines | ||
| 47 | 73 | end |
| 48 | 74 | |
| 49 | 75 | version '1.6' do |
| 50 | − self.release = '1.6.5' | |
| 76 | + self.release = '1.6.6' | |
| 51 | 77 | self.base_urls = [ |
| 52 | 78 | "https://hexdocs.pm/elixir/#{release}/", |
| 53 | 79 | "https://hexdocs.pm/eex/#{release}/", |
| @@ -97,5 +123,10 @@ module Docs · 43 unmodified lines | ||
| 97 | 123 | 'https://elixir-lang.org/getting-started/' |
| 98 | 124 | ] |
| 99 | 125 | end |
| 126 | + | |
| 127 | + def get_latest_version(opts) | |
| 128 | + doc = fetch_doc('https://hexdocs.pm/elixir/api-reference.html', opts) | |
| 129 | + doc.at_css('h2.sidebar-projectVersion').content.strip[1..-1] | |
| 130 | + end | |
| 100 | 131 | end |
| 101 | 132 | end |
| @@ -56,5 +56,10 @@ module Docs · 55 unmodified lines | ||
| 56 | 56 | https://emberjs.com/api/ember-data/2.14/classes/DS |
| 57 | 57 | ) |
| 58 | 58 | end |
| 59 | + | |
| 60 | + def get_latest_version(opts) | |
| 61 | + doc = fetch_doc('https://emberjs.com/api/ember/release', opts) | |
| 62 | + doc.at_css('.sidebar > .select-container .ember-power-select-selected-item').content.strip | |
| 63 | + end | |
| 59 | 64 | end |
| 60 | 65 | end |
| @@ -55,5 +55,10 @@ module Docs · 54 unmodified lines | ||
| 55 | 55 | version '18' do |
| 56 | 56 | self.release = '18.3' |
| 57 | 57 | end |
| 58 | + | |
| 59 | + def get_latest_version(opts) | |
| 60 | + doc = fetch_doc('https://www.erlang.org/downloads', opts) | |
| 61 | + doc.at_css('.col-lg-3 > ul > li').content.strip.sub(/OTP /, '') | |
| 62 | + end | |
| 58 | 63 | end |
| 59 | 64 | end |
| @@ -20,5 +20,9 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © JS Foundation and other contributors<br> |
| 21 | 21 | Licensed under the MIT License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + get_npm_version('eslint', opts) | |
| 26 | + end | |
| 23 | 27 | end |
| 24 | 28 | end |
| @@ -28,5 +28,9 @@ module Docs · 27 unmodified lines | ||
| 28 | 28 | © 2017 StrongLoop, IBM, and other expressjs.com contributors.<br> |
| 29 | 29 | Licensed under the Creative Commons Attribution-ShareAlike License v3.0. |
| 30 | 30 | HTML |
| 31 | + | |
| 32 | + def get_latest_version(opts) | |
| 33 | + get_npm_version('express', opts) | |
| 34 | + end | |
| 31 | 35 | end |
| 32 | 36 | end |
| @@ -33,5 +33,10 @@ module Docs · 32 unmodified lines | ||
| 33 | 33 | self.release = '1.2.0' |
| 34 | 34 | self.base_url = "https://falcon.readthedocs.io/en/#{self.release}/" |
| 35 | 35 | end |
| 36 | + | |
| 37 | + def get_latest_version(opts) | |
| 38 | + doc = fetch_doc('https://falcon.readthedocs.io/en/stable/changes/index.html', opts) | |
| 39 | + doc.at_css('#changelogs ul > li > a').content | |
| 40 | + end | |
| 36 | 41 | end |
| 37 | 42 | end |
| @@ -12,11 +12,17 @@ module Docs · 11 unmodified lines | ||
| 12 | 12 | |
| 13 | 13 | options[:skip] = %w(design.html license.html) |
| 14 | 14 | |
| 15 | + # https://fishshell.com/docs/current/license.html | |
| 15 | 16 | options[:attribution] = <<-HTML |
| 16 | 17 | © 2005–2009 Axel Liljencrantz<br> |
| 17 | 18 | Licensed under the GNU General Public License, version 2. |
| 18 | 19 | HTML |
| 19 | 20 | |
| 21 | + version '3.0' do | |
| 22 | + self.release = '3.0.1' | |
| 23 | + self.base_url = "https://fishshell.com/docs/#{version}/" | |
| 24 | + end | |
| 25 | + | |
| 20 | 26 | version '2.7' do |
| 21 | 27 | self.release = '2.7.1' |
| 22 | 28 | self.base_url = "https://fishshell.com/docs/#{version}/" |
| @@ -46,5 +52,10 @@ module Docs · 23 unmodified lines | ||
| 46 | 52 | self.release = '2.2.0' |
| 47 | 53 | self.base_url = "https://fishshell.com/docs/#{version}/" |
| 48 | 54 | end |
| 55 | + | |
| 56 | + def get_latest_version(opts) | |
| 57 | + doc = fetch_doc('http://fishshell.com/docs/current/index.html', opts) | |
| 58 | + doc.at_css('#toc-index').content.scan(/([0-9.]+)/)[0][0] | |
| 59 | + end | |
| 49 | 60 | end |
| 50 | 61 | end |
| @@ -18,5 +18,9 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2013–present Facebook Inc.<br> |
| 19 | 19 | Licensed under the MIT License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + get_npm_version('flow-bin', opts) | |
| 24 | + end | |
| 21 | 25 | end |
| 22 | 26 | end |
| @@ -19,5 +19,10 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2005–2018 Linus Torvalds and others<br> |
| 20 | 20 | Licensed under the GNU General Public License version 2. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + doc = fetch_doc('https://git-scm.com/', opts) | |
| 25 | + doc.at_css('.version').content.strip | |
| 26 | + end | |
| 22 | 27 | end |
| 23 | 28 | end |
| @@ -99,5 +99,11 @@ module Docs · 98 unmodified lines | ||
| 99 | 99 | |
| 100 | 100 | options[:replace_paths] = CPP_PATHS |
| 101 | 101 | end |
| 102 | + | |
| 103 | + def get_latest_version(opts) | |
| 104 | + doc = fetch_doc('https://gcc.gnu.org/onlinedocs/', opts) | |
| 105 | + label = doc.at_css('ul > li > ul > li > a').content.strip | |
| 106 | + label.scan(/([0-9.]+)/)[0][0] | |
| 107 | + end | |
| 102 | 108 | end |
| 103 | 109 | end |
| @@ -25,5 +25,11 @@ module Docs · 24 unmodified lines | ||
| 25 | 25 | self.release = '4.9.3' |
| 26 | 26 | self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/" |
| 27 | 27 | end |
| 28 | + | |
| 29 | + def get_latest_version(opts) | |
| 30 | + doc = fetch_doc('https://gcc.gnu.org/onlinedocs/', opts) | |
| 31 | + label = doc.at_css('ul > li > ul > li > a').content.strip | |
| 32 | + label.scan(/([0-9.]+)/)[0][0] | |
| 33 | + end | |
| 28 | 34 | end |
| 29 | 35 | end |
| @@ -1,7 +1,7 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Go < UrlScraper |
| 3 | 3 | self.type = 'go' |
| 4 | − self.release = '1.11.2' | |
| 4 | + self.release = '1.12' | |
| 5 | 5 | self.base_url = 'https://golang.org/pkg/' |
| 6 | 6 | self.links = { |
| 7 | 7 | home: 'https://golang.org/', |
| @@ -24,6 +24,11 @@ module Docs · 16 unmodified lines | ||
| 24 | 24 | Licensed under the Creative Commons Attribution License 3.0. |
| 25 | 25 | HTML |
| 26 | 26 | |
| 27 | + def get_latest_version(opts) | |
| 28 | + doc = fetch_doc('https://golang.org/project/', opts) | |
| 29 | + doc.at_css('#page ul > li > a').text[3..-1] | |
| 30 | + end | |
| 31 | + | |
| 27 | 32 | private |
| 28 | 33 | |
| 29 | 34 | def parse(response) # Hook here because Nokogori removes whitespace from textareas |
| @@ -37,5 +37,10 @@ module Docs · 36 unmodified lines | ||
| 37 | 37 | self.release = '2.1' |
| 38 | 38 | self.base_url = "http://docs.godotengine.org/en/#{self.version}/" |
| 39 | 39 | end |
| 40 | + | |
| 41 | + def get_latest_version(opts) | |
| 42 | + doc = fetch_doc('https://docs.godotengine.org/', opts) | |
| 43 | + doc.at_css('.version').content.strip | |
| 44 | + end | |
| 40 | 45 | end |
| 41 | 46 | end |
| @@ -17,5 +17,10 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | © 2011–2016 The Graphite Project<br> |
| 18 | 18 | Licensed under the Apache License, Version 2.0. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + doc = fetch_doc('https://graphite.readthedocs.io/en/latest/releases.html', opts) | |
| 23 | + doc.at_css('#release-notes li > a').content | |
| 24 | + end | |
| 20 | 25 | end |
| 21 | 26 | end |
| @@ -26,5 +26,9 @@ module Docs · 25 unmodified lines | ||
| 26 | 26 | © GruntJS Team<br> |
| 27 | 27 | Licensed under the MIT License. |
| 28 | 28 | HTML |
| 29 | + | |
| 30 | + def get_latest_version(opts) | |
| 31 | + get_npm_version('grunt-cli', opts) | |
| 32 | + end | |
| 29 | 33 | end |
| 30 | 34 | end |
| @@ -19,5 +19,9 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2011–2017 by Yehuda Katz<br> |
| 20 | 20 | Licensed under the MIT License. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_npm_version('handlebars', opts) | |
| 25 | + end | |
| 22 | 26 | end |
| 23 | 27 | end |
| @@ -10,7 +10,7 @@ module Docs · 9 unmodified lines | ||
| 10 | 10 | |
| 11 | 11 | html_filters.push 'haskell/entries', 'haskell/clean_html' |
| 12 | 12 | |
| 13 | − options[:container] = ->(filter) { filter.subpath.start_with?('users_guide') ? '.body' : '#content' } | |
| 13 | + options[:container] = ->(filter) {filter.subpath.start_with?('users_guide') ? '.body' : '#content'} | |
| 14 | 14 | |
| 15 | 15 | options[:only_patterns] = [/\Alibraries\//, /\Ausers_guide\//] |
| 16 | 16 | options[:skip_patterns] = [ |
| @@ -68,5 +68,12 @@ module Docs · 51 unmodified lines | ||
| 68 | 68 | |
| 69 | 69 | options[:only_patterns] = [/\Alibraries\//] |
| 70 | 70 | end |
| 71 | + | |
| 72 | + def get_latest_version(opts) | |
| 73 | + doc = fetch_doc('https://downloads.haskell.org/~ghc/latest/docs/html/', opts) | |
| 74 | + links = doc.css('a').to_a | |
| 75 | + versions = links.map {|link| link['href'].scan(/ghc-([0-9.]+)/)} | |
| 76 | + versions.find {|version| !version.empty?}[0][0] | |
| 77 | + end | |
| 71 | 78 | end |
| 72 | 79 | end |
| @@ -66,5 +66,11 @@ module Docs · 65 unmodified lines | ||
| 66 | 66 | version 'Python' do |
| 67 | 67 | self.base_url = 'https://api.haxe.org/python/' |
| 68 | 68 | end |
| 69 | + | |
| 70 | + def get_latest_version(opts) | |
| 71 | + doc = fetch_doc('https://api.haxe.org/', opts) | |
| 72 | + label = doc.at_css('.container.main-content h1 > small').content | |
| 73 | + label.sub(/version /, '') | |
| 74 | + end | |
| 69 | 75 | end |
| 70 | 76 | end |
| @@ -2,7 +2,7 @@ module Docs · 1 unmodified line | ||
| 2 | 2 | class Homebrew < UrlScraper |
| 3 | 3 | self.name = 'Homebrew' |
| 4 | 4 | self.type = 'simple' |
| 5 | − self.release = '1.8.1' | |
| 5 | + self.release = '2.1.9' | |
| 6 | 6 | self.base_url = 'https://docs.brew.sh/' |
| 7 | 7 | self.links = { |
| 8 | 8 | home: 'https://brew.sh', |
| @@ -19,5 +19,9 @@ module Docs · 10 unmodified lines | ||
| 19 | 19 | © 2009–present Homebrew contributors<br> |
| 20 | 20 | Licensed under the BSD 2-Clause License. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_latest_github_release('Homebrew', 'brew', opts) | |
| 25 | + end | |
| 22 | 26 | end |
| 23 | 27 | end |
| @@ -7,6 +7,8 @@ module Docs · 6 unmodified lines | ||
| 7 | 7 | |
| 8 | 8 | html_filters.push 'http/clean_html', 'http/entries', 'title' |
| 9 | 9 | |
| 10 | + options[:mdn_tag] = 'HTTP' | |
| 11 | + | |
| 10 | 12 | options[:root_title] = 'HTTP' |
| 11 | 13 | options[:title] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? false : filter.default_title } |
| 12 | 14 | options[:container] = ->(filter) { filter.current_url.host == 'tools.ietf.org' ? '.content' : nil } |
| @@ -54,5 +54,9 @@ module Docs · 53 unmodified lines | ||
| 54 | 54 | JS |
| 55 | 55 | capybara.html |
| 56 | 56 | end |
| 57 | + | |
| 58 | + def get_latest_version(opts) | |
| 59 | + get_npm_version('immutable', opts) | |
| 60 | + end | |
| 57 | 61 | end |
| 58 | 62 | end |
| @@ -46,5 +46,11 @@ module Docs · 45 unmodified lines | ||
| 46 | 46 | © 2015 InfluxData, Inc.<br> |
| 47 | 47 | Licensed under the MIT license. |
| 48 | 48 | HTML |
| 49 | + | |
| 50 | + def get_latest_version(opts) | |
| 51 | + doc = fetch_doc('https://docs.influxdata.com/influxdb/', opts) | |
| 52 | + label = doc.at_css('.navbar--current-product').content.strip | |
| 53 | + label.scan(/([0-9.]+)/)[0][0] | |
| 54 | + end | |
| 49 | 55 | end |
| 50 | 56 | end |
| @@ -17,5 +17,9 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | © 2008–2017 Pivotal Labs<br> |
| 18 | 18 | Licensed under the MIT License. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + get_latest_github_release('jasmine', 'jasmine', opts) | |
| 23 | + end | |
| 20 | 24 | end |
| 21 | 25 | end |
| @@ -28,5 +28,10 @@ module Docs · 27 unmodified lines | ||
| 28 | 28 | © 2008–2018 Tom Preston-Werner and Jekyll contributors<br> |
| 29 | 29 | Licensed under the MIT license. |
| 30 | 30 | HTML |
| 31 | + | |
| 32 | + def get_latest_version(opts) | |
| 33 | + doc = fetch_doc('https://jekyllrb.com/docs/', opts) | |
| 34 | + doc.at_css('.meta a').content[1..-1] | |
| 35 | + end | |
| 31 | 36 | end |
| 32 | 37 | end |
| @@ -17,5 +17,10 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | © 2014–present Facebook Inc.<br> |
| 18 | 18 | Licensed under the BSD License. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + doc = fetch_doc('https://jestjs.io/docs/en/getting-started', opts) | |
| 23 | + doc.at_css('header > a > h3').content | |
| 24 | + end | |
| 20 | 25 | end |
| 21 | 26 | end |
| @@ -22,5 +22,9 @@ module Docs · 21 unmodified lines | ||
| 22 | 22 | /Selectors\/odd/i, |
| 23 | 23 | /index/i |
| 24 | 24 | ] |
| 25 | + | |
| 26 | + def get_latest_version(opts) | |
| 27 | + get_npm_version('jquery', opts) | |
| 28 | + end | |
| 25 | 29 | end |
| 26 | 30 | end |
| @@ -16,5 +16,10 @@ module Docs · 15 unmodified lines | ||
| 16 | 16 | options[:fix_urls] = ->(url) do |
| 17 | 17 | url.sub! 'http://api.jquerymobile.com/', 'https://api.jquerymobile.com/' |
| 18 | 18 | end |
| 19 | + | |
| 20 | + def get_latest_version(opts) | |
| 21 | + doc = fetch_doc('https://jquerymobile.com/', opts) | |
| 22 | + doc.at_css('.download-box > .download-option:last-child > span').content.sub(/Version /, '') | |
| 23 | + end | |
| 19 | 24 | end |
| 20 | 25 | end |
| @@ -15,5 +15,9 @@ module Docs · 14 unmodified lines | ||
| 15 | 15 | options[:fix_urls] = ->(url) do |
| 16 | 16 | url.sub! 'http://api.jqueryui.com/', 'https://api.jqueryui.com/' |
| 17 | 17 | end |
| 18 | + | |
| 19 | + def get_latest_version(opts) | |
| 20 | + get_npm_version('jquery-ui', opts) | |
| 21 | + end | |
| 18 | 22 | end |
| 19 | 23 | end |
| @@ -21,5 +21,9 @@ module Docs · 20 unmodified lines | ||
| 21 | 21 | © 2011–2017 the contributors to the JSDoc 3 documentation project<br> |
| 22 | 22 | Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0. |
| 23 | 23 | HTML |
| 24 | + | |
| 25 | + def get_latest_version(opts) | |
| 26 | + get_latest_github_release('jsdoc3', 'jsdoc', opts) | |
| 27 | + end | |
| 24 | 28 | end |
| 25 | 29 | end |
| @@ -49,5 +49,9 @@ module Docs · 48 unmodified lines | ||
| 49 | 49 | |
| 50 | 50 | html_filters.push 'julia/entries_sphinx', 'julia/clean_html_sphinx', 'sphinx/clean_html' |
| 51 | 51 | end |
| 52 | + | |
| 53 | + def get_latest_version(opts) | |
| 54 | + get_latest_github_release('JuliaLang', 'julia', opts) | |
| 55 | + end | |
| 52 | 56 | end |
| 53 | 57 | end |
| @@ -33,5 +33,9 @@ module Docs · 32 unmodified lines | ||
| 33 | 33 | © Steven Sanderson, the Knockout.js team, and other contributors<br> |
| 34 | 34 | Licensed under the MIT License. |
| 35 | 35 | HTML |
| 36 | + | |
| 37 | + def get_latest_version(opts) | |
| 38 | + get_latest_github_release('knockout', 'knockout', opts) | |
| 39 | + end | |
| 36 | 40 | end |
| 37 | 41 | end |
| @@ -34,5 +34,9 @@ module Docs · 33 unmodified lines | ||
| 34 | 34 | © 2018 Koa contributors<br> |
| 35 | 35 | Licensed under the MIT License. |
| 36 | 36 | HTML |
| 37 | + | |
| 38 | + def get_latest_version(opts) | |
| 39 | + get_npm_version('koa', opts) | |
| 40 | + end | |
| 37 | 41 | end |
| 38 | 42 | end |
| @@ -1,7 +1,7 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Kotlin < UrlScraper |
| 3 | 3 | self.type = 'kotlin' |
| 4 | − self.release = '1.2.41' | |
| 4 | + self.release = '1.3.41' | |
| 5 | 5 | self.base_url = 'https://kotlinlang.org/' |
| 6 | 6 | self.root_path = 'api/latest/jvm/stdlib/index.html' |
| 7 | 7 | self.links = { |
| @@ -22,11 +22,23 @@ module Docs · 14 unmodified lines | ||
| 22 | 22 | docs/events.html |
| 23 | 23 | docs/resources.html |
| 24 | 24 | docs/reference/grammar.html) |
| 25 | − options[:replace_paths] = { 'api/latest/jvm/stdlib/' => 'api/latest/jvm/stdlib/index.html' } | |
| 25 | + options[:replace_paths] = { | |
| 26 | + 'api/latest/jvm/stdlib/' => 'api/latest/jvm/stdlib/index.html', | |
| 27 | + 'docs/reference/coroutines.html' => 'docs/reference/coroutines-overview.html', | |
| 28 | + 'api/latest/jvm/stdlib/kotlin/fold.html' => 'api/latest/jvm/stdlib/kotlin.collections/fold.html', | |
| 29 | + 'api/latest/jvm/stdlib/kotlin/get-or-else.html' => 'api/latest/jvm/stdlib/kotlin.collections/get-or-else.html', | |
| 30 | + 'api/latest/jvm/stdlib/kotlin/map.html' => 'api/latest/jvm/stdlib/kotlin.collections/map.html', | |
| 31 | + 'docs/tutorials/native/targeting-multiple-platforms.html' => 'docs/tutorials/native/basic-kotlin-native-app.html', | |
| 32 | + 'api/latest/jvm/stdlib/kotlin/-throwable/print-stack-trace.html' => 'api/latest/jvm/stdlib/kotlin/print-stack-trace.html', | |
| 33 | + } | |
| 26 | 34 | |
| 27 | 35 | options[:attribution] = <<-HTML |
| 28 | − © 2010–2018 JetBrains s.r.o.<br> | |
| 36 | + © 2010–2019 JetBrains s.r.o.<br> | |
| 29 | 37 | Licensed under the Apache License, Version 2.0. |
| 30 | 38 | HTML |
| 39 | + | |
| 40 | + def get_latest_version(opts) | |
| 41 | + get_latest_github_release('JetBrains', 'kotlin', opts) | |
| 42 | + end | |
| 31 | 43 | end |
| 32 | 44 | end |
| @@ -133,5 +133,9 @@ module Docs · 132 unmodified lines | ||
| 133 | 133 | url |
| 134 | 134 | end |
| 135 | 135 | end |
| 136 | + | |
| 137 | + def get_latest_version(opts) | |
| 138 | + get_latest_github_release('laravel', 'laravel', opts) | |
| 139 | + end | |
| 136 | 140 | end |
| 137 | 141 | end |
| @@ -14,11 +14,21 @@ module Docs · 13 unmodified lines | ||
| 14 | 14 | options[:skip_links] = true |
| 15 | 15 | |
| 16 | 16 | options[:attribution] = <<-HTML |
| 17 | − © 2010–2018 Vladimir Agafonkin<br> | |
| 17 | + © 2010–2019 Vladimir Agafonkin<br> | |
| 18 | 18 | © 2010–2011, CloudMade<br> |
| 19 | 19 | Maps © OpenStreetMap contributors. |
| 20 | 20 | HTML |
| 21 | 21 | |
| 22 | + version '1.5' do | |
| 23 | + self.release = '1.5.0' | |
| 24 | + self.base_url = "https://leafletjs.com/reference-#{release}.html" | |
| 25 | + end | |
| 26 | + | |
| 27 | + version '1.4' do | |
| 28 | + self.release = '1.4.0' | |
| 29 | + self.base_url = "https://leafletjs.com/reference-#{release}.html" | |
| 30 | + end | |
| 31 | + | |
| 22 | 32 | version '1.3' do |
| 23 | 33 | self.release = '1.3.4' |
| 24 | 34 | self.base_url = "https://leafletjs.com/reference-#{release}.html" |
| @@ -39,5 +49,10 @@ module Docs · 14 unmodified lines | ||
| 39 | 49 | self.base_url = "https://leafletjs.com/reference-#{release}.html" |
| 40 | 50 | end |
| 41 | 51 | |
| 52 | + def get_latest_version(opts) | |
| 53 | + doc = fetch_doc('https://leafletjs.com/index.html', opts) | |
| 54 | + link = doc.css('ul > li > a').to_a.select {|node| node.content == 'Docs'}.first | |
| 55 | + link['href'].scan(/reference-([0-9.]+)\.html/)[0][0] | |
| 56 | + end | |
| 42 | 57 | end |
| 43 | 58 | end |
| @@ -21,5 +21,11 @@ module Docs · 20 unmodified lines | ||
| 21 | 21 | © 2009–2016 The Core Less Team<br> |
| 22 | 22 | Licensed under the Creative Commons Attribution License 3.0. |
| 23 | 23 | HTML |
| 24 | + | |
| 25 | + def get_latest_version(opts) | |
| 26 | + doc = fetch_doc('http://lesscss.org/features/', opts) | |
| 27 | + label = doc.at_css('.footer-links > li').content | |
| 28 | + label.scan(/([0-9.]+)/)[0][0] | |
| 29 | + end | |
| 24 | 30 | end |
| 25 | 31 | end |
| @@ -19,5 +19,10 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2005, 2006 Tobias Luetke<br> |
| 20 | 20 | Licensed under the MIT License. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + tags = get_github_tags('Shopify', 'liquid', opts) | |
| 25 | + tags[0]['name'][1..-1] | |
| 26 | + end | |
| 22 | 27 | end |
| 23 | 28 | end |
| @@ -32,5 +32,10 @@ module Docs · 31 unmodified lines | ||
| 32 | 32 | self.release = '2.4.2' |
| 33 | 33 | self.base_url = "https://lodash.com/docs/#{release}" |
| 34 | 34 | end |
| 35 | + | |
| 36 | + def get_latest_version(opts) | |
| 37 | + doc = fetch_doc('https://lodash.com/docs/', opts) | |
| 38 | + doc.at_css('#version > option[selected]').content | |
| 39 | + end | |
| 35 | 40 | end |
| 36 | 41 | end |
| @@ -39,5 +39,10 @@ module Docs · 38 unmodified lines | ||
| 39 | 39 | © 2006–2016 LÖVE Development Team<br> |
| 40 | 40 | Licensed under the GNU Free Documentation License, Version 1.3. |
| 41 | 41 | HTML |
| 42 | + | |
| 43 | + def get_latest_version(opts) | |
| 44 | + doc = fetch_doc('https://love2d.org/wiki/Version_History', opts) | |
| 45 | + doc.at_css('#mw-content-text table a').content | |
| 46 | + end | |
| 42 | 47 | end |
| 43 | 48 | end |
| @@ -26,5 +26,10 @@ module Docs · 25 unmodified lines | ||
| 26 | 26 | self.release = '5.1.5' |
| 27 | 27 | self.base_url = 'https://www.lua.org/manual/5.1/' |
| 28 | 28 | end |
| 29 | + | |
| 30 | + def get_latest_version(opts) | |
| 31 | + doc = fetch_doc('https://www.lua.org/manual/', opts) | |
| 32 | + doc.at_css('p.menubar > a').content | |
| 33 | + end | |
| 29 | 34 | end |
| 30 | 35 | end |
| @@ -38,5 +38,9 @@ module Docs · 37 unmodified lines | ||
| 38 | 38 | |
| 39 | 39 | html_filters.push 'marionette/entries_v2' |
| 40 | 40 | end |
| 41 | + | |
| 42 | + def get_latest_version(opts) | |
| 43 | + get_npm_version('backbone.marionette', opts) | |
| 44 | + end | |
| 41 | 45 | end |
| 42 | 46 | end |
| @@ -13,5 +13,9 @@ module Docs · 12 unmodified lines | ||
| 13 | 13 | © 2004 John Gruber<br> |
| 14 | 14 | Licensed under the BSD License. |
| 15 | 15 | HTML |
| 16 | + | |
| 17 | + def get_latest_version(opts) | |
| 18 | + '1.0.0' | |
| 19 | + end | |
| 16 | 20 | end |
| 17 | 21 | end |
| @@ -20,6 +20,15 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | Licensed under the Matplotlib License Agreement. |
| 21 | 21 | HTML |
| 22 | 22 | |
| 23 | + version '3.1' do | |
| 24 | + self.release = '3.1.1' | |
| 25 | + self.base_urls = [ | |
| 26 | + "https://matplotlib.org/#{release}/api/", | |
| 27 | + "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/", | |
| 28 | + "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/" | |
| 29 | + ] | |
| 30 | + end | |
| 31 | + | |
| 23 | 32 | version '3.0' do |
| 24 | 33 | self.release = '3.0.0' |
| 25 | 34 | self.base_urls = [ |
| @@ -64,5 +73,9 @@ module Docs · 38 unmodified lines | ||
| 64 | 73 | "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/" |
| 65 | 74 | ] |
| 66 | 75 | end |
| 76 | + | |
| 77 | + def get_latest_version(opts) | |
| 78 | + get_latest_github_release('matplotlib', 'matplotlib', opts) | |
| 79 | + end | |
| 67 | 80 | end |
| 68 | 81 | end |
| @@ -6,6 +6,8 @@ module Docs · 5 unmodified lines | ||
| 6 | 6 | |
| 7 | 7 | html_filters.push 'css/clean_html', 'css/entries', 'title' |
| 8 | 8 | |
| 9 | + options[:mdn_tag] = 'CSS' | |
| 10 | + | |
| 9 | 11 | options[:root_title] = 'CSS' |
| 10 | 12 | |
| 11 | 13 | options[:skip] = %w(/CSS3 /Media/Visual /paged_media /Media/TV /Media/Tactile) |
| @@ -8,6 +8,8 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | |
| 9 | 9 | html_filters.push 'dom/clean_html', 'dom/entries', 'title' |
| 10 | 10 | |
| 11 | + options[:mdn_tag] = 'XSLT_Reference' | |
| 12 | + | |
| 11 | 13 | options[:root_title] = 'DOM' |
| 12 | 14 | |
| 13 | 15 | options[:skip] = %w( |
| @@ -9,6 +9,8 @@ module Docs · 8 unmodified lines | ||
| 9 | 9 | html_filters.insert_after 'clean_html', 'dom_events/clean_html' |
| 10 | 10 | html_filters.push 'dom_events/entries', 'title' |
| 11 | 11 | |
| 12 | + options[:mdn_tag] = 'events' | |
| 13 | + | |
| 12 | 14 | options[:root_title] = 'DOM Events' |
| 13 | 15 | |
| 14 | 16 | options[:skip] = %w(/MozOrientation) |
| @@ -7,6 +7,8 @@ module Docs · 6 unmodified lines | ||
| 7 | 7 | |
| 8 | 8 | html_filters.push 'html/clean_html', 'html/entries', 'title' |
| 9 | 9 | |
| 10 | + options[:mdn_tag] = 'HTML' | |
| 11 | + | |
| 10 | 12 | options[:root_title] = 'HTML' |
| 11 | 13 | |
| 12 | 14 | options[:title] = ->(filter) do |
| @@ -8,6 +8,8 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | |
| 9 | 9 | html_filters.push 'javascript/clean_html', 'javascript/entries', 'title' |
| 10 | 10 | |
| 11 | + options[:mdn_tag] = 'JavaScript' | |
| 12 | + | |
| 11 | 13 | options[:root_title] = 'JavaScript' |
| 12 | 14 | |
| 13 | 15 | # Don't want |
| @@ -21,6 +21,11 @@ module Docs · 20 unmodified lines | ||
| 21 | 21 | Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later. |
| 22 | 22 | HTML |
| 23 | 23 | |
| 24 | + def get_latest_version(opts) | |
| 25 | + json = fetch_json("https://developer.mozilla.org/en-US/docs/feeds/json/tag/#{options[:mdn_tag]}", opts) | |
| 26 | + DateTime.parse(json[0]['pubdate']).to_time.to_i | |
| 27 | + end | |
| 28 | + | |
| 24 | 29 | private |
| 25 | 30 | |
| 26 | 31 | def process_response?(response) |
| @@ -8,6 +8,8 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | |
| 9 | 9 | html_filters.push 'svg/clean_html', 'svg/entries', 'title' |
| 10 | 10 | |
| 11 | + options[:mdn_tag] = 'XSLT_Reference' | |
| 12 | + | |
| 11 | 13 | options[:root_title] = 'SVG' |
| 12 | 14 | |
| 13 | 15 | options[:title] = ->(filter) do |
| @@ -8,6 +8,8 @@ module Docs · 7 unmodified lines | ||
| 8 | 8 | |
| 9 | 9 | html_filters.push 'xslt_xpath/clean_html', 'xslt_xpath/entries', 'title' |
| 10 | 10 | |
| 11 | + options[:mdn_tag] = 'XSLT_Reference' | |
| 12 | + | |
| 11 | 13 | options[:root_title] = 'XSLT' |
| 12 | 14 | |
| 13 | 15 | options[:only_patterns] = [/\A\/XSLT/, /\A\/XPath/] |
| @@ -45,5 +45,10 @@ module Docs · 44 unmodified lines | ||
| 45 | 45 | self.base_urls = ['https://guide.meteor.com/v1.3/', "https://docs.meteor.com/v#{self.release}/"] |
| 46 | 46 | options[:fix_urls] = nil |
| 47 | 47 | end |
| 48 | + | |
| 49 | + def get_latest_version(opts) | |
| 50 | + doc = fetch_doc('https://docs.meteor.com/#/full/', opts) | |
| 51 | + doc.at_css('select.version-select > option').content | |
| 52 | + end | |
| 48 | 53 | end |
| 49 | 54 | end |
| @@ -18,5 +18,9 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2011–2018 JS Foundation and contributors<br> |
| 19 | 19 | Licensed under the Creative Commons Attribution 4.0 International License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + get_npm_version('mocha', opts) | |
| 24 | + end | |
| 21 | 25 | end |
| 22 | 26 | end |
| @@ -15,5 +15,9 @@ module Docs · 14 unmodified lines | ||
| 15 | 15 | © 2009–2017 The Modernizr team<br> |
| 16 | 16 | Licensed under the MIT License. |
| 17 | 17 | HTML |
| 18 | + | |
| 19 | + def get_latest_version(opts) | |
| 20 | + get_npm_version('modernizr', opts) | |
| 21 | + end | |
| 18 | 22 | end |
| 19 | 23 | end |
| @@ -22,5 +22,10 @@ module Docs · 21 unmodified lines | ||
| 22 | 22 | © JS Foundation and other contributors<br> |
| 23 | 23 | Licensed under the MIT License. |
| 24 | 24 | HTML |
| 25 | + | |
| 26 | + def get_latest_version(opts) | |
| 27 | + doc = fetch_doc('http://momentjs.com/', opts) | |
| 28 | + doc.at_css('.hero-title > h1 > span').content | |
| 29 | + end | |
| 25 | 30 | end |
| 26 | 31 | end |
| @@ -26,5 +26,11 @@ module Docs · 25 unmodified lines | ||
| 26 | 26 | © 2010 LearnBoost<br> |
| 27 | 27 | Licensed under the MIT License. |
| 28 | 28 | HTML |
| 29 | + | |
| 30 | + def get_latest_version(opts) | |
| 31 | + doc = fetch_doc('https://mongoosejs.com/docs/', opts) | |
| 32 | + label = doc.at_css('.pure-menu-link').content.strip | |
| 33 | + label.sub(/Version /, '') | |
| 34 | + end | |
| 29 | 35 | end |
| 30 | 36 | end |
| @@ -2,11 +2,11 @@ module Docs · 1 unmodified line | ||
| 2 | 2 | class Nginx < UrlScraper |
| 3 | 3 | self.name = 'nginx' |
| 4 | 4 | self.type = 'nginx' |
| 5 | − self.release = '1.15.5' | |
| 5 | + self.release = '1.17.2' | |
| 6 | 6 | self.base_url = 'https://nginx.org/en/docs/' |
| 7 | 7 | self.links = { |
| 8 | 8 | home: 'https://nginx.org/', |
| 9 | − code: 'http://hg.nginx.org/nginx' | |
| 9 | + code: 'https://hg.nginx.org/nginx' | |
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | html_filters.push 'nginx/clean_html', 'nginx/entries' |
| @@ -21,9 +21,15 @@ module Docs · 8 unmodified lines | ||
| 21 | 21 | options[:skip_patterns] = [/\/faq\//] |
| 22 | 22 | |
| 23 | 23 | options[:attribution] = <<-HTML |
| 24 | − © 2002-2018 Igor Sysoev<br> | |
| 25 | − © 2011-2018 Nginx, Inc.<br> | |
| 24 | + © 2002-2019 Igor Sysoev<br> | |
| 25 | + © 2011-2019 Nginx, Inc.<br> | |
| 26 | 26 | Licensed under the BSD License. |
| 27 | 27 | HTML |
| 28 | + | |
| 29 | + def get_latest_version(opts) | |
| 30 | + doc = fetch_doc('https://nginx.org/en/download.html', opts) | |
| 31 | + table = doc.at_css('#content > table').inner_html | |
| 32 | + table.scan(/nginx-([0-9.]+)</)[0][0] | |
| 33 | + end | |
| 28 | 34 | end |
| 29 | 35 | end |
| @@ -4,6 +4,9 @@ module Docs · 3 unmodified lines | ||
| 4 | 4 | self.slug = 'nginx_lua_module' |
| 5 | 5 | self.release = '0.10.13' |
| 6 | 6 | self.base_url = "https://github.com/openresty/lua-nginx-module/tree/v#{self.release}/" |
| 7 | + self.links = { | |
| 8 | + code: 'https://github.com/openresty/lua-nginx-module' | |
| 9 | + } | |
| 7 | 10 | |
| 8 | 11 | html_filters.push 'nginx_lua_module/clean_html', 'nginx_lua_module/entries', 'title' |
| 9 | 12 | |
| @@ -15,5 +18,11 @@ module Docs · 5 unmodified lines | ||
| 15 | 18 | © 2009–2018 Yichun "agentzh" Zhang (章亦春), OpenResty Inc.<br> |
| 16 | 19 | Licensed under the BSD License. |
| 17 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + tags = get_github_tags('openresty', 'lua-nginx-module', opts) | |
| 24 | + tag = tags.find {|tag| !tag['name'].include?('rc')} | |
| 25 | + tag['name'][1..-1] | |
| 26 | + end | |
| 18 | 27 | end |
| 19 | 28 | end |
| @@ -17,5 +17,10 @@ module Docs · 16 unmodified lines | ||
| 17 | 17 | © 2006–2018 Andreas Rumpf<br> |
| 18 | 18 | Licensed under the MIT License. |
| 19 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + doc = fetch_doc('https://nim-lang.org/docs/overview.html', opts) | |
| 23 | + doc.at_css('.container > .docinfo > tbody > tr:last-child > td').content.strip | |
| 24 | + end | |
| 20 | 25 | end |
| 21 | 26 | end |
| @@ -23,8 +23,8 @@ module Docs · 22 unmodified lines | ||
| 23 | 23 | HTML |
| 24 | 24 | |
| 25 | 25 | version do |
| 26 | − self.release = '11.1.0' | |
| 27 | − self.base_url = 'https://nodejs.org/dist/latest-v11.x/docs/api/' | |
| 26 | + self.release = '12.8.0' | |
| 27 | + self.base_url = 'https://nodejs.org/dist/latest-v12.x/docs/api/' | |
| 28 | 28 | end |
| 29 | 29 | |
| 30 | 30 | version '10 LTS' do |
| @@ -46,5 +46,10 @@ module Docs · 15 unmodified lines | ||
| 46 | 46 | self.release = '4.9.1' |
| 47 | 47 | self.base_url = 'https://nodejs.org/dist/latest-v4.x/docs/api/' |
| 48 | 48 | end |
| 49 | + | |
| 50 | + def get_latest_version(opts) | |
| 51 | + doc = fetch_doc('https://nodejs.org/en/', opts) | |
| 52 | + doc.at_css('#home-intro > .home-downloadblock:last-of-type > a')['data-version'][1..-1] | |
| 53 | + end | |
| 49 | 54 | end |
| 50 | 55 | end |
| @@ -1,8 +1,13 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Nokogiri2 < Rdoc |
| 3 | + # Instructions: | |
| 4 | + # 1. Download the latest release at https://github.com/sparklemotion/nokogiri/releases | |
| 5 | + # 2. Run "bundle install && bundle exec rake docs" (in the Nokogiri directory) | |
| 6 | + # 4. Copy the "doc" directory to "docs/nokgiri" | |
| 7 | + | |
| 3 | 8 | self.name = 'Nokogiri' |
| 4 | 9 | self.slug = 'nokogiri' |
| 5 | − self.release = '1.8.1' | |
| 10 | + self.release = '1.9.0' | |
| 6 | 11 | |
| 7 | 12 | html_filters.replace 'rdoc/entries', 'nokogiri2/entries' |
| 8 | 13 | |
| @@ -10,9 +15,13 @@ module Docs · 1 unmodified line | ||
| 10 | 15 | options[:only_patterns] = [/\ANokogiri/, /\AXSD/] |
| 11 | 16 | |
| 12 | 17 | options[:attribution] = <<-HTML |
| 13 | − © 2008–2017 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo<br> | |
| 14 | − Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid<br> | |
| 18 | + © 2008–2018 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo,<br> | |
| 19 | + Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid, Lars Kanis<br> | |
| 15 | 20 | Licensed under the MIT License. |
| 16 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_latest_github_release('sparklemotion', 'nokogiri', opts) | |
| 25 | + end | |
| 17 | 26 | end |
| 18 | 27 | end |
| @@ -29,5 +29,9 @@ module Docs · 28 unmodified lines | ||
| 29 | 29 | Licensed under the npm License.<br> |
| 30 | 30 | npm is a trademark of npm, Inc. |
| 31 | 31 | HTML |
| 32 | + | |
| 33 | + def get_latest_version(opts) | |
| 34 | + get_latest_github_release('npm', 'cli', opts) | |
| 35 | + end | |
| 32 | 36 | end |
| 33 | 37 | end |
| @@ -49,5 +49,9 @@ module Docs · 48 unmodified lines | ||
| 49 | 49 | self.release = '1.10.4' |
| 50 | 50 | self.base_url = "https://docs.scipy.org/doc/numpy-#{self.release}/reference/" |
| 51 | 51 | end |
| 52 | + | |
| 53 | + def get_latest_version(opts) | |
| 54 | + get_latest_github_release('numpy', 'numpy', opts) | |
| 55 | + end | |
| 52 | 56 | end |
| 53 | 57 | end |
| @@ -86,5 +86,25 @@ module Docs · 85 unmodified lines | ||
| 86 | 86 | def read_file(path) |
| 87 | 87 | File.read(path).force_encoding('iso-8859-1').encode('utf-8') rescue nil |
| 88 | 88 | end |
| 89 | + | |
| 90 | + def get_latest_version(opts) | |
| 91 | + latest_version = 8 | |
| 92 | + current_attempt = latest_version | |
| 93 | + attempts = 0 | |
| 94 | + | |
| 95 | + while attempts < 3 | |
| 96 | + current_attempt += 1 | |
| 97 | + | |
| 98 | + doc = fetch_doc("https://packages.debian.org/sid/openjdk-#{current_attempt}-doc", opts) | |
| 99 | + if doc.at_css('.perror').nil? | |
| 100 | + latest_version = current_attempt | |
| 101 | + attempts = 0 | |
| 102 | + else | |
| 103 | + attempts += 1 | |
| 104 | + end | |
| 105 | + end | |
| 106 | + | |
| 107 | + latest_version | |
| 108 | + end | |
| 89 | 109 | end |
| 90 | 110 | end |
| @@ -18,5 +18,9 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2010–2016 The OpenTSDB Authors<br> |
| 19 | 19 | Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + get_latest_github_release('OpenTSDB', 'opentsdb', opts) | |
| 24 | + end | |
| 21 | 25 | end |
| 22 | 26 | end |
| @@ -2,8 +2,8 @@ module Docs · 1 unmodified line | ||
| 2 | 2 | class Padrino < UrlScraper |
| 3 | 3 | self.slug = 'padrino' |
| 4 | 4 | self.type = 'rubydoc' |
| 5 | − self.release = '0.14.1' | |
| 6 | − self.base_url = 'http://www.rubydoc.info/github/padrino/padrino-framework/' | |
| 5 | + self.release = '0.14.4' | |
| 6 | + self.base_url = 'https://www.rubydoc.info/github/padrino/padrino-framework/' | |
| 7 | 7 | self.root_path = 'file/README.rdoc' |
| 8 | 8 | self.initial_paths = %w(index2) |
| 9 | 9 | self.links = { |
| @@ -16,12 +16,16 @@ module Docs · 6 unmodified lines | ||
| 16 | 16 | options[:container] = ->(filter) { filter.root_page? ? '#filecontents' : '#content' } |
| 17 | 17 | |
| 18 | 18 | options[:attribution] = <<-HTML |
| 19 | − © 2010–2016 Padrino<br> | |
| 19 | + © 2010–2019 Padrino<br> | |
| 20 | 20 | Licensed under the MIT License. |
| 21 | 21 | HTML |
| 22 | 22 | |
| 23 | 23 | stub 'index2' do |
| 24 | 24 | request_one(url_for('index')).body |
| 25 | 25 | end |
| 26 | + | |
| 27 | + def get_latest_version(opts) | |
| 28 | + get_github_tags('padrino', 'padrino-framework', opts)[0]['name'] | |
| 29 | + end | |
| 26 | 30 | end |
| 27 | 31 | end |
| @@ -14,40 +14,57 @@ module Docs · 13 unmodified lines | ||
| 14 | 14 | options[:container] = '.document' |
| 15 | 15 | |
| 16 | 16 | options[:skip] = %w(internals.html release.html contributing.html whatsnew.html) |
| 17 | + options[:skip_patterns] = [/whatsnew\//] | |
| 17 | 18 | |
| 18 | 19 | options[:attribution] = <<-HTML |
| 19 | 20 | © 2008–2012, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team<br> |
| 20 | 21 | Licensed under the 3-clause BSD License. |
| 21 | 22 | HTML |
| 22 | 23 | |
| 24 | + version '0.25' do | |
| 25 | + self.release = '0.25.0' | |
| 26 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 27 | + end | |
| 28 | + | |
| 29 | + version '0.24' do | |
| 30 | + self.release = '0.24.2' | |
| 31 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 32 | + end | |
| 33 | + | |
| 23 | 34 | version '0.23' do |
| 24 | 35 | self.release = '0.23.4' |
| 25 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 36 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 26 | 37 | end |
| 27 | 38 | |
| 28 | 39 | version '0.22' do |
| 29 | 40 | self.release = '0.22.0' |
| 30 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 41 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 31 | 42 | end |
| 32 | 43 | |
| 33 | 44 | version '0.21' do |
| 34 | − self.release = '0.21.0' | |
| 35 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 45 | + self.release = '0.21.1' | |
| 46 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 36 | 47 | end |
| 37 | 48 | |
| 38 | 49 | version '0.20' do |
| 39 | 50 | self.release = '0.20.3' |
| 40 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 51 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 41 | 52 | end |
| 42 | 53 | |
| 43 | 54 | version '0.19' do |
| 44 | 55 | self.release = '0.19.2' |
| 45 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 56 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 46 | 57 | end |
| 47 | 58 | |
| 48 | 59 | version '0.18' do |
| 49 | 60 | self.release = '0.18.1' |
| 50 | − self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 61 | + self.base_url = "https://pandas.pydata.org/pandas-docs/version/#{self.release}/" | |
| 62 | + end | |
| 63 | + | |
| 64 | + def get_latest_version(opts) | |
| 65 | + doc = fetch_doc('http://pandas.pydata.org/pandas-docs/stable/', opts) | |
| 66 | + label = doc.at_css('.body > .section > p').content | |
| 67 | + label.scan(/Version: ([0-9.]+)/)[0][0] | |
| 51 | 68 | end |
| 52 | 69 | end |
| 53 | 70 | end |
| @@ -43,5 +43,11 @@ module Docs · 42 unmodified lines | ||
| 43 | 43 | self.release = '5.20.2' |
| 44 | 44 | self.base_url = "https://perldoc.perl.org/#{self.release}/" |
| 45 | 45 | end |
| 46 | + | |
| 47 | + def get_latest_version(opts) | |
| 48 | + doc = fetch_doc('https://perldoc.perl.org/', opts) | |
| 49 | + header = doc.at_css('h2.h1').content | |
| 50 | + header.scan(/Perl ([0-9.]+)/)[0][0] | |
| 51 | + end | |
| 46 | 52 | end |
| 47 | 53 | end |
| @@ -29,5 +29,10 @@ module Docs · 28 unmodified lines | ||
| 29 | 29 | self.release = '2.0.13' |
| 30 | 30 | self.base_url = 'https://docs.phalconphp.com/en/2.0.0/' |
| 31 | 31 | end |
| 32 | + | |
| 33 | + def get_latest_version(opts) | |
| 34 | + doc = fetch_doc('https://docs.phalconphp.com/', opts) | |
| 35 | + doc.at_css('.header__lang.expand > div > ul > li > a').content | |
| 36 | + end | |
| 32 | 37 | end |
| 33 | 38 | end |
| @@ -25,5 +25,9 @@ module Docs · 24 unmodified lines | ||
| 25 | 25 | © 2016 Richard Davey, Photon Storm Ltd.<br> |
| 26 | 26 | Licensed under the MIT License. |
| 27 | 27 | HTML |
| 28 | + | |
| 29 | + def get_latest_version(opts) | |
| 30 | + get_latest_github_release('photonstorm', 'phaser', opts) | |
| 31 | + end | |
| 28 | 32 | end |
| 29 | 33 | end |
| @@ -46,5 +46,10 @@ module Docs · 45 unmodified lines | ||
| 46 | 46 | HTML |
| 47 | 47 | end |
| 48 | 48 | } |
| 49 | + | |
| 50 | + def get_latest_version(opts) | |
| 51 | + doc = fetch_doc('https://hexdocs.pm/phoenix/Phoenix.html', opts) | |
| 52 | + doc.at_css('.sidebar-projectVersion').content.strip[1..-1] | |
| 53 | + end | |
| 49 | 54 | end |
| 50 | 55 | end |
| @@ -66,5 +66,11 @@ module Docs · 65 unmodified lines | ||
| 66 | 66 | © 1997–2018 The PHP Documentation Group<br> |
| 67 | 67 | Licensed under the Creative Commons Attribution License v3.0 or later. |
| 68 | 68 | HTML |
| 69 | + | |
| 70 | + def get_latest_version(opts) | |
| 71 | + doc = fetch_doc('https://secure.php.net/manual/en/doc.changelog.php', opts) | |
| 72 | + label = doc.at_css('tbody.gen-changelog > tr > td').content | |
| 73 | + label.split(',').last.strip | |
| 74 | + end | |
| 69 | 75 | end |
| 70 | 76 | end |
| @@ -37,5 +37,11 @@ module Docs · 36 unmodified lines | ||
| 37 | 37 | self.release = '4.8' |
| 38 | 38 | self.base_url = "https://phpunit.de/manual/#{release}/en/" |
| 39 | 39 | end |
| 40 | + | |
| 41 | + def get_latest_version(opts) | |
| 42 | + doc = fetch_doc('https://phpunit.readthedocs.io/', opts) | |
| 43 | + label = doc.at_css('.rst-current-version').content.strip | |
| 44 | + label.scan(/v: ([0-9.]+)/)[0][0] | |
| 45 | + end | |
| 40 | 46 | end |
| 41 | 47 | end |
| @@ -80,5 +80,11 @@ module Docs · 79 unmodified lines | ||
| 80 | 80 | |
| 81 | 81 | html_filters.insert_before 'postgresql/extract_metadata', 'postgresql/normalize_class_names' |
| 82 | 82 | end |
| 83 | + | |
| 84 | + def get_latest_version(opts) | |
| 85 | + doc = fetch_doc('https://www.postgresql.org/docs/current/index.html', opts) | |
| 86 | + label = doc.at_css('#pgContentWrap h1.title').content | |
| 87 | + label.scan(/([0-9.]+)/)[0][0] | |
| 88 | + end | |
| 83 | 89 | end |
| 84 | 90 | end |
| @@ -18,6 +18,10 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | Licensed under the MIT license. |
| 19 | 19 | HTML |
| 20 | 20 | |
| 21 | + def get_latest_version(opts) | |
| 22 | + get_npm_version('pug', opts) | |
| 23 | + end | |
| 24 | + | |
| 21 | 25 | private |
| 22 | 26 | |
| 23 | 27 | def parse(response) # Hook here because Nokogori removes whitespace from textareas |
| @@ -14,5 +14,10 @@ module Docs · 13 unmodified lines | ||
| 14 | 14 | © 2017 Google Inc<br> |
| 15 | 15 | Licensed under the Apache License 2.0. |
| 16 | 16 | HTML |
| 17 | + | |
| 18 | + def get_latest_version(opts) | |
| 19 | + contents = get_github_file_contents('GoogleChrome', 'puppeteer', 'README.md', opts) | |
| 20 | + contents.scan(/\/v([0-9.]+)\/docs\/api\.md/)[0][0] | |
| 21 | + end | |
| 17 | 22 | end |
| 18 | 23 | end |
| @@ -1,7 +1,8 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Pygame < UrlScraper |
| 3 | 3 | self.type = 'simple' |
| 4 | − self.release = '1.9.4' | |
| 4 | + self.release = '1.9.6' | |
| 5 | + self.base_url = 'https://www.pygame.org/docs/' | |
| 5 | 6 | self.root_path = 'py-modindex.html' |
| 6 | 7 | self.links = { |
| 7 | 8 | home: 'https://www.pygame.org/', |
| @@ -13,8 +14,12 @@ module Docs · 5 unmodified lines | ||
| 13 | 14 | options[:only_patterns] = [/ref\//] |
| 14 | 15 | |
| 15 | 16 | options[:attribution] = <<-HTML |
| 16 | − © Pygame Developpers.<br> | |
| 17 | + © Pygame Developers.<br> | |
| 17 | 18 | Licensed under the GNU LGPL License version 2.1. |
| 18 | 19 | HTML |
| 20 | + | |
| 21 | + def get_latest_version(opts) | |
| 22 | + get_latest_github_release('pygame', 'pygame', opts) | |
| 23 | + end | |
| 19 | 24 | end |
| 20 | 25 | end |
| @@ -24,31 +24,36 @@ module Docs · 23 unmodified lines | ||
| 24 | 24 | HTML |
| 25 | 25 | |
| 26 | 26 | version '3.7' do # docs.python.org/3.7/download.html |
| 27 | − self.release = '3.7.0' | |
| 27 | + self.release = '3.7.4' | |
| 28 | 28 | self.base_url = 'https://docs.python.org/3.7/' |
| 29 | 29 | |
| 30 | 30 | html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html' |
| 31 | 31 | end |
| 32 | 32 | |
| 33 | 33 | version '3.6' do # docs.python.org/3.6/download.html |
| 34 | − self.release = '3.6.6' | |
| 34 | + self.release = '3.6.9' | |
| 35 | 35 | self.base_url = 'https://docs.python.org/3.6/' |
| 36 | 36 | |
| 37 | 37 | html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html' |
| 38 | 38 | end |
| 39 | 39 | |
| 40 | 40 | version '3.5' do # docs.python.org/3.5/download.html |
| 41 | − self.release = '3.5.3' | |
| 41 | + self.release = '3.5.7' | |
| 42 | 42 | self.base_url = 'https://docs.python.org/3.5/' |
| 43 | 43 | |
| 44 | 44 | html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html' |
| 45 | 45 | end |
| 46 | 46 | |
| 47 | 47 | version '2.7' do # docs.python.org/2.7/download.html |
| 48 | − self.release = '2.7.13' | |
| 48 | + self.release = '2.7.16' | |
| 49 | 49 | self.base_url = 'https://docs.python.org/2.7/' |
| 50 | 50 | |
| 51 | 51 | html_filters.push 'python/entries_v2', 'sphinx/clean_html', 'python/clean_html' |
| 52 | 52 | end |
| 53 | + | |
| 54 | + def get_latest_version(opts) | |
| 55 | + doc = fetch_doc('https://docs.python.org/', opts) | |
| 56 | + doc.at_css('.version_switcher_placeholder').content | |
| 57 | + end | |
| 53 | 58 | end |
| 54 | 59 | end |
| @@ -19,5 +19,9 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2009–2017 Kristopher Michael Kowal<br> |
| 20 | 20 | Licensed under the MIT License. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_npm_version('q', opts) | |
| 25 | + end | |
| 22 | 26 | end |
| 23 | 27 | end |
| @@ -103,9 +103,19 @@ module Docs · 102 unmodified lines | ||
| 103 | 103 | Licensed under the GNU Free Documentation License, Version 1.3. |
| 104 | 104 | HTML |
| 105 | 105 | |
| 106 | + version '5.13' do | |
| 107 | + self.release = '5.13' | |
| 108 | + self.base_url = 'https://doc.qt.io/qt-5.13/' | |
| 109 | + end | |
| 110 | + | |
| 111 | + version '5.12' do | |
| 112 | + self.release = '5.12' | |
| 113 | + self.base_url = 'https://doc.qt.io/qt-5.12/' | |
| 114 | + end | |
| 115 | + | |
| 106 | 116 | version '5.11' do |
| 107 | 117 | self.release = '5.11' |
| 108 | − self.base_url = 'https://doc.qt.io/qt-5/' | |
| 118 | + self.base_url = 'https://doc.qt.io/archives/qt-5.11/' | |
| 109 | 119 | end |
| 110 | 120 | |
| 111 | 121 | version '5.9' do |
| @@ -115,7 +125,12 @@ module Docs · 3 unmodified lines | ||
| 115 | 125 | |
| 116 | 126 | version '5.6' do |
| 117 | 127 | self.release = '5.6' |
| 118 | − self.base_url = 'https://doc.qt.io/qt-5.6/' | |
| 128 | + self.base_url = 'https://doc.qt.io/archives/qt-5.6/' | |
| 129 | + end | |
| 130 | + | |
| 131 | + def get_latest_version(opts) | |
| 132 | + doc = fetch_doc('https://doc.qt.io/qt-5/index.html', opts) | |
| 133 | + doc.at_css('.mainContent h1.title').content.sub(/Qt /, '') | |
| 119 | 134 | end |
| 120 | 135 | end |
| 121 | 136 | end |
| @@ -1,8 +1,8 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Ramda < UrlScraper |
| 3 | 3 | self.type = 'ramda' |
| 4 | − self.release = '0.25.0' | |
| 5 | − self.base_url = "http://ramdajs.com/#{release}/docs/" | |
| 4 | + self.release = '0.26.1' | |
| 5 | + self.base_url = "https://ramdajs.com/#{release}/docs/" | |
| 6 | 6 | self.links = { |
| 7 | 7 | home: 'http://ramdajs.com/', |
| 8 | 8 | code: 'https://github.com/ramda/ramda/' |
| @@ -15,6 +15,10 @@ module Docs · 6 unmodified lines | ||
| 15 | 15 | © 2013–2016 Scott Sauyet and Michael Hurley<br> |
| 16 | 16 | Licensed under the MIT License. |
| 17 | 17 | HTML |
| 18 | + | |
| 19 | + def get_latest_version(opts) | |
| 20 | + doc = fetch_doc('https://ramdajs.com/docs/', opts) | |
| 21 | + doc.at_css('.navbar-brand > .version').content[1..-1] | |
| 22 | + end | |
| 18 | 23 | end |
| 19 | 24 | end |
| 20 | − | |
| @@ -1,9 +1,14 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Minitest < Rdoc |
| 3 | − # Run "rake docs" in the gem directory | |
| 3 | + # Instructions: | |
| 4 | + # 1. Run "gem update rdoc hoe" | |
| 5 | + # 2. Download the source code at https://github.com/seattlerb/minitest | |
| 6 | + # 3. Run "rake docs" (in the Minitest directory) | |
| 7 | + # 4. Copy the "docs" directory to "docs/minitest" | |
| 8 | + | |
| 4 | 9 | self.name = 'Ruby / Minitest' |
| 5 | 10 | self.slug = 'minitest' |
| 6 | − self.release = '5.10.3' | |
| 11 | + self.release = '5.11.3' | |
| 7 | 12 | self.links = { |
| 8 | 13 | code: 'https://github.com/seattlerb/minitest' |
| 9 | 14 | } |
| @@ -16,5 +21,10 @@ module Docs · 6 unmodified lines | ||
| 16 | 21 | © Ryan Davis, seattle.rb<br> |
| 17 | 22 | Licensed under the MIT License. |
| 18 | 23 | HTML |
| 24 | + | |
| 25 | + def get_latest_version(opts) | |
| 26 | + contents = get_github_file_contents('seattlerb', 'minitest', 'History.rdoc', opts) | |
| 27 | + contents.scan(/([0-9.]+)/)[0][0] | |
| 28 | + end | |
| 19 | 29 | end |
| 20 | 30 | end |
| @@ -1,5 +1,13 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Rails < Rdoc |
| 3 | + # Instructions: | |
| 4 | + # 1. Download a release at https://github.com/rails/rails/releases | |
| 5 | + # 2. Open "railties/lib/rails/api/task.rb" and comment out any code related to sdoc ("configure_sdoc") | |
| 6 | + # 3. Run "bundle install --without db && bundle exec rake rdoc" (in the Rails directory) | |
| 7 | + # 4. Run "cd guides && bundle exec rake guides:generate:html" | |
| 8 | + # 5. Copy the "guides/output" directory to "html/guides" | |
| 9 | + # 6. Copy the "html" directory to "docs/rails~[version]" | |
| 10 | + | |
| 3 | 11 | include FixInternalUrlsBehavior |
| 4 | 12 | |
| 5 | 13 | self.name = 'Ruby on Rails' |
| @@ -67,7 +75,7 @@ module Docs · 61 unmodified lines | ||
| 67 | 75 | end |
| 68 | 76 | |
| 69 | 77 | version '5.2' do |
| 70 | − self.release = '5.2.0' | |
| 78 | + self.release = '5.2.2' | |
| 71 | 79 | end |
| 72 | 80 | |
| 73 | 81 | version '5.1' do |
| @@ -79,11 +87,15 @@ module Docs · 5 unmodified lines | ||
| 79 | 87 | end |
| 80 | 88 | |
| 81 | 89 | version '4.2' do |
| 82 | − self.release = '4.2.10' | |
| 90 | + self.release = '4.2.11' | |
| 83 | 91 | end |
| 84 | 92 | |
| 85 | 93 | version '4.1' do |
| 86 | 94 | self.release = '4.1.16' |
| 87 | 95 | end |
| 96 | + | |
| 97 | + def get_latest_version(opts) | |
| 98 | + get_latest_github_release('rails', 'rails', opts) | |
| 99 | + end | |
| 88 | 100 | end |
| 89 | 101 | end |
| @@ -1,16 +1,9 @@ | ||
| 1 | 1 | module Docs |
| 2 | 2 | class Ruby < Rdoc |
| 3 | − # Generated with: | |
| 4 | − # ./configure && make html | |
| 5 | − # or: | |
| 6 | − # rdoc \ | |
| 7 | − # --root . \ | |
| 8 | − # --page-dir doc \ | |
| 9 | − # --encoding=UTF-8 \ | |
| 10 | − # --visibility=public \ | |
| 11 | − # --format=darkfish \ | |
| 12 | − # --no-line-numbers \ | |
| 13 | − # --op html . | |
| 3 | + # Instructions: | |
| 4 | + # 1. Download Ruby's source code | |
| 5 | + # 2. Run "./configure && make html" (in the Ruby directory) | |
| 6 | + # 3. Copy the ".ext/html" directory to "docs/ruby~[version]" | |
| 14 | 7 | |
| 15 | 8 | include FixInternalUrlsBehavior |
| 16 | 9 | |
| @@ -77,19 +70,30 @@ module Docs · 60 unmodified lines | ||
| 77 | 70 | HTML |
| 78 | 71 | |
| 79 | 72 | version '2.5' do |
| 80 | − self.release = '2.5.0' | |
| 73 | + self.release = '2.5.3' | |
| 81 | 74 | end |
| 82 | 75 | |
| 83 | 76 | version '2.4' do |
| 84 | − self.release = '2.4.3' | |
| 77 | + self.release = '2.4.5' | |
| 85 | 78 | end |
| 86 | 79 | |
| 87 | 80 | version '2.3' do |
| 88 | − self.release = '2.3.6' | |
| 81 | + self.release = '2.3.8' | |
| 89 | 82 | end |
| 90 | 83 | |
| 91 | 84 | version '2.2' do |
| 92 | − self.release = '2.2.9' | |
| 85 | + self.release = '2.2.10' | |
| 86 | + end | |
| 87 | + | |
| 88 | + def get_latest_version(opts) | |
| 89 | + tags = get_github_tags('ruby', 'ruby', opts) | |
| 90 | + tags.each do |tag| | |
| 91 | + version = tag['name'].gsub(/_/, '.')[1..-1] | |
| 92 | + | |
| 93 | + if !/^([0-9.]+)$/.match(version).nil? && version.count('.') == 2 | |
| 94 | + return version | |
| 95 | + end | |
| 96 | + end | |
| 93 | 97 | end |
| 94 | 98 | end |
| 95 | 99 | end |
| @@ -30,5 +30,10 @@ module Docs · 29 unmodified lines | ||
| 30 | 30 | © 2013–present Facebook Inc.<br> |
| 31 | 31 | Licensed under the Creative Commons Attribution 4.0 International Public License. |
| 32 | 32 | HTML |
| 33 | + | |
| 34 | + def get_latest_version(opts) | |
| 35 | + doc = fetch_doc('https://reactjs.org/docs/getting-started.html', opts) | |
| 36 | + doc.at_css('a[href="/versions"]').content.strip[1..-1] | |
| 37 | + end | |
| 33 | 38 | end |
| 34 | 39 | end |
| @@ -30,5 +30,10 @@ module Docs · 29 unmodified lines | ||
| 30 | 30 | © 2015–2018 Facebook Inc.<br> |
| 31 | 31 | Licensed under the Creative Commons Attribution 4.0 International Public License. |
| 32 | 32 | HTML |
| 33 | + | |
| 34 | + def get_latest_version(opts) | |
| 35 | + doc = fetch_doc('https://facebook.github.io/react-native/docs/getting-started.html', opts) | |
| 36 | + doc.at_css('header > a > h3').content | |
| 37 | + end | |
| 33 | 38 | end |
| 34 | 39 | end |
| @@ -19,5 +19,11 @@ module Docs · 18 unmodified lines | ||
| 19 | 19 | © 2009–2018 Salvatore Sanfilippo<br> |
| 20 | 20 | Licensed under the Creative Commons Attribution-ShareAlike License 4.0. |
| 21 | 21 | HTML |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + body = fetch('http://download.redis.io/redis-stable/00-RELEASENOTES', opts) | |
| 25 | + body = body.lines[1..-1].join | |
| 26 | + body.scan(/Redis ([0-9.]+)/)[0][0] | |
| 27 | + end | |
| 22 | 28 | end |
| 23 | 29 | end |
| @@ -20,5 +20,9 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | stub '' do |
| 21 | 21 | request_one('http://redux.js.org/index.html').body |
| 22 | 22 | end |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + get_npm_version('redux', opts) | |
| 26 | + end | |
| 23 | 27 | end |
| 24 | 28 | end |
| @@ -18,5 +18,10 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2013–present Facebook Inc.<br> |
| 19 | 19 | Licensed under the BSD License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + doc = fetch_doc('http://facebook.github.io/relay/en/', opts) | |
| 24 | + doc.at_css('header > a > h3').content[1..-1] | |
| 25 | + end | |
| 21 | 26 | end |
| 22 | 27 | end |
| @@ -30,5 +30,9 @@ module Docs · 29 unmodified lines | ||
| 30 | 30 | © jQuery Foundation and other contributors<br> |
| 31 | 31 | Licensed under the MIT License. |
| 32 | 32 | HTML |
| 33 | + | |
| 34 | + def get_latest_version(opts) | |
| 35 | + get_npm_version('requirejs', opts) | |
| 36 | + end | |
| 33 | 37 | end |
| 34 | 38 | end |
| @@ -58,6 +58,10 @@ module Docs · 57 unmodified lines | ||
| 58 | 58 | CODE |
| 59 | 59 | end |
| 60 | 60 | |
| 61 | + def get_latest_version(opts) | |
| 62 | + get_latest_github_release('rethinkdb', 'rethinkdb', opts) | |
| 63 | + end | |
| 64 | + | |
| 61 | 65 | private |
| 62 | 66 | |
| 63 | 67 | def process_response?(response) |
| @@ -39,6 +39,12 @@ module Docs · 38 unmodified lines | ||
| 39 | 39 | Licensed under the Apache License, Version 2.0 or the MIT license, at your option. |
| 40 | 40 | HTML |
| 41 | 41 | |
| 42 | + def get_latest_version(opts) | |
| 43 | + doc = fetch_doc('https://www.rust-lang.org/', opts) | |
| 44 | + label = doc.at_css('.button-download + p > a').content | |
| 45 | + label.sub(/Version /, '') | |
| 46 | + end | |
| 47 | + | |
| 42 | 48 | private |
| 43 | 49 | |
| 44 | 50 | REDIRECT_RGX = /http-equiv="refresh"/i |
| @@ -0,0 +1,36 @@ | ||
| 1 | +module Docs | |
| 2 | + # The official documentation website is heavily rate-limited | |
| 3 | + # | |
| 4 | + # The documentation can be generated like this (replace 2019.2 with the correct tag): | |
| 5 | + # $ git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1 | |
| 6 | + # $ cd salt/doc | |
| 7 | + # $ pip install sphinx | |
| 8 | + # $ make html | |
| 9 | + # | |
| 10 | + # The generated html can be found in salt/doc/_build/html | |
| 11 | + class SaltStack < FileScraper | |
| 12 | + self.type = 'simple' | |
| 13 | + self.slug = 'saltstack' | |
| 14 | + self.release = '2019.2.0' | |
| 15 | + self.base_url = 'https://docs.saltstack.com/en/latest/' | |
| 16 | + self.root_path = 'ref/index.html' | |
| 17 | + self.links = { | |
| 18 | + home: 'https://www.saltstack.com/', | |
| 19 | + code: 'https://github.com/saltstack/salt' | |
| 20 | + } | |
| 21 | + | |
| 22 | + html_filters.push 'salt_stack/clean_html', 'salt_stack/entries' | |
| 23 | + | |
| 24 | + options[:only_patterns] = [/all\//] | |
| 25 | + options[:container] = '.body-content > .section' | |
| 26 | + | |
| 27 | + options[:attribution] = <<-HTML | |
| 28 | + © 2019 SaltStack.<br> | |
| 29 | + Licensed under the Apache License, Version 2.0. | |
| 30 | + HTML | |
| 31 | + | |
| 32 | + def get_latest_version(opts) | |
| 33 | + get_latest_github_release('saltstack', 'salt', opts) | |
| 34 | + end | |
| 35 | + end | |
| 36 | +end | |
| @@ -23,5 +23,9 @@ module Docs · 22 unmodified lines | ||
| 23 | 23 | © 2006–2016 Hampton Catlin, Nathan Weizenbaum, and Chris Eppstein<br> |
| 24 | 24 | Licensed under the MIT License. |
| 25 | 25 | HTML |
| 26 | + | |
| 27 | + def get_latest_version(opts) | |
| 28 | + get_latest_github_release('sass', 'libsass', opts) | |
| 29 | + end | |
| 26 | 30 | end |
| 27 | 31 | end |
| @@ -0,0 +1,61 @@ | ||
| 1 | +module Docs | |
| 2 | + class Scala < FileScraper | |
| 3 | + self.name = 'Scala' | |
| 4 | + self.type = 'scala' | |
| 5 | + self.links = { | |
| 6 | + home: 'http://www.scala-lang.org/', | |
| 7 | + code: 'https://github.com/scala/scala' | |
| 8 | + } | |
| 9 | + | |
| 10 | + options[:container] = '#content-container' | |
| 11 | + options[:attribution] = <<-HTML | |
| 12 | + © 2002-2019 EPFL, with contributions from Lightbend.<br> | |
| 13 | + Licensed under the Apache License, Version 2.0. | |
| 14 | + HTML | |
| 15 | + | |
| 16 | + # https://downloads.lightbend.com/scala/2.13.0/scala-docs-2.13.0.zip | |
| 17 | + # Extract api/scala-library into docs/scala~2.13_library | |
| 18 | + version '2.13 Library' do | |
| 19 | + self.release = '2.13.0' | |
| 20 | + self.base_url = 'https://www.scala-lang.org/api/2.13.0/' | |
| 21 | + self.root_path = 'index.html' | |
| 22 | + | |
| 23 | + html_filters.push 'scala/entries', 'scala/clean_html' | |
| 24 | + end | |
| 25 | + | |
| 26 | + # https://downloads.lightbend.com/scala/2.13.0/scala-docs-2.13.0.zip | |
| 27 | + # Extract api/scala-reflect into docs/scala~2.13_reflection | |
| 28 | + version '2.13 Reflection' do | |
| 29 | + self.release = '2.13.0' | |
| 30 | + self.base_url = 'https://www.scala-lang.org/api/2.13.0/scala-reflect/' | |
| 31 | + self.root_path = 'index.html' | |
| 32 | + | |
| 33 | + html_filters.push 'scala/entries', 'scala/clean_html' | |
| 34 | + end | |
| 35 | + | |
| 36 | + # https://downloads.lightbend.com/scala/2.12.9/scala-docs-2.12.9.zip | |
| 37 | + # Extract api/scala-library into docs/scala~2.12_library | |
| 38 | + version '2.12 Library' do | |
| 39 | + self.release = '2.12.9' | |
| 40 | + self.base_url = 'https://www.scala-lang.org/api/2.12.9/' | |
| 41 | + self.root_path = 'index.html' | |
| 42 | + | |
| 43 | + html_filters.push 'scala/entries', 'scala/clean_html' | |
| 44 | + end | |
| 45 | + | |
| 46 | + # https://downloads.lightbend.com/scala/2.12.9/scala-docs-2.12.9.zip | |
| 47 | + # Extract api/scala-reflect into docs/scala~2.12_reflection | |
| 48 | + version '2.12 Reflection' do | |
| 49 | + self.release = '2.12.9' | |
| 50 | + self.base_url = 'https://www.scala-lang.org/api/2.12.9/scala-reflect/' | |
| 51 | + self.root_path = 'index.html' | |
| 52 | + | |
| 53 | + html_filters.push 'scala/entries', 'scala/clean_html' | |
| 54 | + end | |
| 55 | + | |
| 56 | + def get_latest_version(opts) | |
| 57 | + doc = fetch_doc('https://www.scala-lang.org/api/current/', opts) | |
| 58 | + doc.at_css('#doc-version').content | |
| 59 | + end | |
| 60 | + end | |
| 61 | +end | |
| @@ -20,5 +20,10 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © 2011 the scikit-image team<br> |
| 21 | 21 | Licensed under the BSD 3-clause License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + tags = get_github_tags('scikit-image', 'scikit-image', opts) | |
| 26 | + tags[0]['name'][1..-1] | |
| 27 | + end | |
| 23 | 28 | end |
| 24 | 29 | end |
| @@ -25,5 +25,9 @@ module Docs · 24 unmodified lines | ||
| 25 | 25 | Licensed under the 3-clause BSD License. |
| 26 | 26 | HTML |
| 27 | 27 | |
| 28 | + def get_latest_version(opts) | |
| 29 | + doc = fetch_doc('https://scikit-learn.org/stable/documentation.html', opts) | |
| 30 | + doc.at_css('.body h1').content.scan(/([0-9.]+)/)[0][0] | |
| 31 | + end | |
| 28 | 32 | end |
| 29 | 33 | end |
| @@ -52,5 +52,10 @@ module Docs · 51 unmodified lines | ||
| 52 | 52 | self.release = '1.17.7' |
| 53 | 53 | self.base_url = "https://sinonjs.org/releases/v#{release}/" |
| 54 | 54 | end |
| 55 | + | |
| 56 | + def get_latest_version(opts) | |
| 57 | + body = fetch('https://sinonjs.org/', opts) | |
| 58 | + body.scan(/\/releases\/v([0-9.]+)/)[0][0] | |
| 59 | + end | |
| 55 | 60 | end |
| 56 | 61 | end |
| @@ -20,5 +20,9 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © 2014–2015 Automattic<br> |
| 21 | 21 | Licensed under the MIT License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + get_npm_version('socket.io', opts) | |
| 26 | + end | |
| 23 | 27 | end |
| 24 | 28 | end |
| @@ -41,6 +41,11 @@ module Docs · 40 unmodified lines | ||
| 41 | 41 | |
| 42 | 42 | options[:attribution] = 'SQLite is in the Public Domain.' |
| 43 | 43 | |
| 44 | + def get_latest_version(opts) | |
| 45 | + doc = fetch_doc('https://sqlite.org/chronology.html', opts) | |
| 46 | + doc.at_css('#chrontab > tbody > tr > td:last-child > a').content | |
| 47 | + end | |
| 48 | + | |
| 44 | 49 | private |
| 45 | 50 | |
| 46 | 51 | def parse(response) |
| @@ -21,5 +21,9 @@ module Docs · 20 unmodified lines | ||
| 21 | 21 | Licensed under the 3-clause BSD License. |
| 22 | 22 | HTML |
| 23 | 23 | |
| 24 | + def get_latest_version(opts) | |
| 25 | + doc = fetch_doc('http://www.statsmodels.org/stable/', opts) | |
| 26 | + doc.at_css('.sphinxsidebarwrapper h3 + p > b').content[1..-1] | |
| 27 | + end | |
| 24 | 28 | end |
| 25 | 29 | end |
| @@ -178,5 +178,11 @@ module Docs · 177 unmodified lines | ||
| 178 | 178 | </p> |
| 179 | 179 | </div> |
| 180 | 180 | HTML |
| 181 | + | |
| 182 | + def get_latest_version(opts) | |
| 183 | + body = fetch('https://feeds.feedburner.com/WhenCanIUse?format=xml', opts) | |
| 184 | + timestamp = body.scan(/<updated>([^<]+)<\/updated>/)[0][0] | |
| 185 | + DateTime.parse(timestamp).to_time.to_i | |
| 186 | + end | |
| 181 | 187 | end |
| 182 | 188 | end |
| @@ -70,5 +70,9 @@ module Docs · 69 unmodified lines | ||
| 70 | 70 | self.release = '2.7.35' |
| 71 | 71 | self.base_url = "https://api.symfony.com/#{version}/" |
| 72 | 72 | end |
| 73 | + | |
| 74 | + def get_latest_version(opts) | |
| 75 | + get_latest_github_release('symfony', 'symfony', opts) | |
| 76 | + end | |
| 73 | 77 | end |
| 74 | 78 | end |
| @@ -25,5 +25,10 @@ module Docs · 24 unmodified lines | ||
| 25 | 25 | options[:attribution] = <<-HTML |
| 26 | 26 | Licensed under <a href="http://tcl.tk/software/tcltk/license.html">Tcl/Tk terms</a> |
| 27 | 27 | HTML |
| 28 | + | |
| 29 | + def get_latest_version(opts) | |
| 30 | + doc = fetch_doc('https://www.tcl.tk/man/tcl/contents.htm', opts) | |
| 31 | + doc.at_css('h2').content.scan(/Tk([0-9.]+)/)[0][0] | |
| 32 | + end | |
| 28 | 33 | end |
| 29 | 34 | end |
| @@ -56,6 +56,10 @@ module Docs · 55 unmodified lines | ||
| 56 | 56 | /\Aextend/] |
| 57 | 57 | end |
| 58 | 58 | |
| 59 | + def get_latest_version(opts) | |
| 60 | + get_latest_github_release('tensorflow', 'tensorflow', opts) | |
| 61 | + end | |
| 62 | + | |
| 59 | 63 | private |
| 60 | 64 | |
| 61 | 65 | def parse(response) |
| @@ -18,5 +18,10 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2018 HashiCorp</br> |
| 19 | 19 | Licensed under the MPL 2.0 License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + contents = get_github_file_contents('hashicorp', 'terraform-website', 'content/config.rb', opts) | |
| 24 | + contents.scan(/version\s+=\s+"([0-9.]+)"/)[0][0] | |
| 25 | + end | |
| 21 | 26 | end |
| 22 | 27 | end |
| @@ -28,5 +28,10 @@ module Docs · 27 unmodified lines | ||
| 28 | 28 | self.release = '1.34.3' |
| 29 | 29 | self.base_url = 'https://twig.symfony.com/doc/1.x/' |
| 30 | 30 | end |
| 31 | + | |
| 32 | + def get_latest_version(opts) | |
| 33 | + tags = get_github_tags('twigphp', 'Twig', opts) | |
| 34 | + tags[0]['name'][1..-1] | |
| 35 | + end | |
| 31 | 36 | end |
| 32 | 37 | end |
| @@ -24,6 +24,10 @@ module Docs · 23 unmodified lines | ||
| 24 | 24 | © Microsoft and other contributors<br> |
| 25 | 25 | Licensed under the Apache License, Version 2.0. |
| 26 | 26 | HTML |
| 27 | + | |
| 28 | + def get_latest_version(opts) | |
| 29 | + get_latest_github_release('Microsoft', 'TypeScript', opts) | |
| 30 | + end | |
| 27 | 31 | end |
| 28 | 32 | end |
| 29 | 33 | |
| @@ -20,5 +20,10 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © 2009–2018 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors<br> |
| 21 | 21 | Licensed under the MIT License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + doc = fetch_doc('https://underscorejs.org/', opts) | |
| 26 | + doc.at_css('.version').content[1...-1] | |
| 27 | + end | |
| 23 | 28 | end |
| 24 | 29 | end |
| @@ -18,5 +18,10 @@ module Docs · 17 unmodified lines | ||
| 18 | 18 | © 2010–2018 Mitchell Hashimoto<br> |
| 19 | 19 | Licensed under the MPL 2.0 License. |
| 20 | 20 | HTML |
| 21 | + | |
| 22 | + def get_latest_version(opts) | |
| 23 | + contents = get_github_file_contents('hashicorp', 'vagrant', 'website/config.rb', opts) | |
| 24 | + contents.scan(/version\s+=\s+"([0-9.]+)"/)[0][0] | |
| 25 | + end | |
| 21 | 26 | end |
| 22 | 27 | end |
| @@ -32,5 +32,9 @@ module Docs · 31 unmodified lines | ||
| 32 | 32 | self.root_path = '/guide/index.html' |
| 33 | 33 | self.initial_paths = %w(/api/index.html) |
| 34 | 34 | end |
| 35 | + | |
| 36 | + def get_latest_version(opts) | |
| 37 | + get_latest_github_release('vuejs', 'vue', opts) | |
| 38 | + end | |
| 35 | 39 | end |
| 36 | 40 | end |
| @@ -0,0 +1,29 @@ | ||
| 1 | +module Docs | |
| 2 | + class VueRouter < UrlScraper | |
| 3 | + self.name = 'Vue Router' | |
| 4 | + self.slug = 'vue_router' | |
| 5 | + self.type = 'simple' | |
| 6 | + self.release = '3.1.2' | |
| 7 | + self.base_url = 'https://router.vuejs.org/' | |
| 8 | + self.links = { | |
| 9 | + home: 'https://router.vuejs.org', | |
| 10 | + code: 'https://github.com/vuejs/vue-router' | |
| 11 | + } | |
| 12 | + | |
| 13 | + html_filters.push 'vue_router/entries', 'vue_router/clean_html' | |
| 14 | + | |
| 15 | + options[:skip_patterns] = [ | |
| 16 | + # Other languages | |
| 17 | + /^(zh|ja|ru|kr|fr)\//, | |
| 18 | + ] | |
| 19 | + | |
| 20 | + options[:attribution] = <<-HTML | |
| 21 | + © 2013–present Evan You<br> | |
| 22 | + Licensed under the MIT License. | |
| 23 | + HTML | |
| 24 | + | |
| 25 | + def get_latest_version(opts) | |
| 26 | + get_latest_github_release('vuejs', 'vue-router', opts) | |
| 27 | + end | |
| 28 | + end | |
| 29 | +end | |
| @@ -0,0 +1,27 @@ | ||
| 1 | +module Docs | |
| 2 | + class Vuex < UrlScraper | |
| 3 | + self.type = 'simple' | |
| 4 | + self.release = '3.1.1' | |
| 5 | + self.base_url = 'https://vuex.vuejs.org/' | |
| 6 | + self.links = { | |
| 7 | + home: 'https://vuex.vuejs.org', | |
| 8 | + code: 'https://github.com/vuejs/vuex' | |
| 9 | + } | |
| 10 | + | |
| 11 | + html_filters.push 'vuex/entries', 'vuex/clean_html' | |
| 12 | + | |
| 13 | + options[:skip_patterns] = [ | |
| 14 | + # Other languages | |
| 15 | + /^(zh|ja|ru|kr|fr|ptbr)\//, | |
| 16 | + ] | |
| 17 | + | |
| 18 | + options[:attribution] = <<-HTML | |
| 19 | + © 2015–present Evan You<br> | |
| 20 | + Licensed under the MIT License. | |
| 21 | + HTML | |
| 22 | + | |
| 23 | + def get_latest_version(opts) | |
| 24 | + get_npm_version('vuex', opts) | |
| 25 | + end | |
| 26 | + end | |
| 27 | +end | |
| @@ -20,5 +20,10 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | Licensed under the Creative Commons Attribution 4.0 International License.<br> |
| 21 | 21 | Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + tags = get_github_tags('KhronosGroup', 'Vulkan-Docs', opts) | |
| 26 | + tags[0]['name'][1..-1] | |
| 27 | + end | |
| 23 | 28 | end |
| 24 | 29 | end |
| @@ -68,5 +68,9 @@ module Docs · 67 unmodified lines | ||
| 68 | 68 | Licensed under the MIT License. |
| 69 | 69 | HTML |
| 70 | 70 | end |
| 71 | + | |
| 72 | + def get_latest_version(opts) | |
| 73 | + get_npm_version('webpack', opts) | |
| 74 | + end | |
| 71 | 75 | end |
| 72 | 76 | end |
| @@ -0,0 +1,44 @@ | ||
| 1 | +module Docs | |
| 2 | + class Wordpress < UrlScraper | |
| 3 | + self.name = 'WordPress' | |
| 4 | + self.type = 'wordpress' | |
| 5 | + self.release = '5.2.2' | |
| 6 | + self.base_url = 'https://developer.wordpress.org/reference/' | |
| 7 | + self.initial_paths = %w( | |
| 8 | + functions/ | |
| 9 | + hooks/ | |
| 10 | + classes/ | |
| 11 | + ) | |
| 12 | + | |
| 13 | + self.links = { | |
| 14 | + home: 'https://wordpress.org/', | |
| 15 | + code: 'https://github.com/WordPress/WordPress' | |
| 16 | + } | |
| 17 | + | |
| 18 | + html_filters.push 'wordpress/entries', 'wordpress/clean_html' | |
| 19 | + | |
| 20 | + options[:container] = '#content-area' | |
| 21 | + options[:trailing_slash] = false | |
| 22 | + options[:only_patterns] = [ | |
| 23 | + /\Afunctions\//, | |
| 24 | + /\Ahooks\//, | |
| 25 | + /\Aclasses\// | |
| 26 | + ] | |
| 27 | + | |
| 28 | + options[:skip_patterns] = [ | |
| 29 | + /\Afunctions\/page\/\d+/, | |
| 30 | + /\Ahooks\/page\/\d+/, | |
| 31 | + /\Aclasses\/page\/\d+/ | |
| 32 | + ] | |
| 33 | + | |
| 34 | + options[:attribution] = <<-HTML | |
| 35 | + © 2003–2019 WordPress Foundation<br> | |
| 36 | + Licensed under the GNU GPLv2+ License. | |
| 37 | + HTML | |
| 38 | + | |
| 39 | + def get_latest_version(opts) | |
| 40 | + doc = fetch_doc('https://wordpress.org/download/releases/', opts) | |
| 41 | + doc.at_css('.releases.latest td').content | |
| 42 | + end | |
| 43 | + end | |
| 44 | +end | |
| @@ -20,5 +20,9 @@ module Docs · 19 unmodified lines | ||
| 20 | 20 | © 2016–present Yarn Contributors<br> |
| 21 | 21 | Licensed under the BSD License. |
| 22 | 22 | HTML |
| 23 | + | |
| 24 | + def get_latest_version(opts) | |
| 25 | + get_latest_github_release('yarnpkg', 'yarn', opts) | |
| 26 | + end | |
| 23 | 27 | end |
| 24 | 28 | end |
| @@ -34,5 +34,9 @@ module Docs · 33 unmodified lines | ||
| 34 | 34 | |
| 35 | 35 | options[:container] = '.grid_9' |
| 36 | 36 | end |
| 37 | + | |
| 38 | + def get_latest_version(opts) | |
| 39 | + get_latest_github_release('yiisoft', 'yii2', opts) | |
| 40 | + end | |
| 37 | 41 | end |
| 38 | 42 | end |
| @@ -14,6 +14,9 @@ class AssetsCLI < Thor · 13 unmodified lines | ||
| 14 | 14 | option :keep, type: :numeric, default: 0, desc: 'Number of old assets to keep' |
| 15 | 15 | option :verbose, type: :boolean |
| 16 | 16 | def compile |
| 17 | + load 'tasks/sprites.thor' | |
| 18 | + invoke 'sprites:generate', [], :remove_public_icons => true, :verbose => options[:verbose] | |
| 19 | + | |
| 17 | 20 | manifest.compile App.assets_compile |
| 18 | 21 | manifest.clean(options[:keep]) if options[:clean] |
| 19 | 22 | end |
| @@ -174,11 +174,24 @@ class DocsCLI < Thor · 173 unmodified lines | ||
| 174 | 174 | |
| 175 | 175 | assert_docs(docs) |
| 176 | 176 | |
| 177 | + # Verify files are present | |
| 178 | + docs.each do |doc| | |
| 179 | + unless Dir.exists?(File.join(Docs.store_path, doc.path)) | |
| 180 | + puts "ERROR: directory #{File.join(Docs.store_path, doc.path)} not found." | |
| 181 | + return | |
| 182 | + end | |
| 183 | + | |
| 184 | + unless File.exists?(File.join(Docs.store_path, "#{doc.path}.tar.gz")) | |
| 185 | + puts "ERROR: package for '#{doc.slug}' documentation not found. Run 'thor docs:package #{doc.slug}' to create it." | |
| 186 | + return | |
| 187 | + end | |
| 188 | + end | |
| 189 | + | |
| 177 | 190 | # Sync files with S3 (used by the web app) |
| 178 | 191 | puts '[S3] Begin syncing.' |
| 179 | 192 | docs.each do |doc| |
| 180 | 193 | puts "[S3] Syncing #{doc.path}..." |
| 181 | − cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://docs.devdocs.io/#{doc.path} --delete" | |
| 194 | + cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://devdocs-assets/#{doc.path} --delete --profile devdocs" | |
| 182 | 195 | cmd << ' --dryrun' if options[:dryrun] |
| 183 | 196 | system(cmd) |
| 184 | 197 | end |
| @@ -0,0 +1,213 @@ | ||
| 1 | +class SpritesCLI < Thor | |
| 2 | + def self.to_s | |
| 3 | + 'Sprites' | |
| 4 | + end | |
| 5 | + | |
| 6 | + def initialize(*args) | |
| 7 | + require 'docs' | |
| 8 | + require 'chunky_png' | |
| 9 | + require 'fileutils' | |
| 10 | + super | |
| 11 | + end | |
| 12 | + | |
| 13 | + desc 'generate [--remove-public-icons] [--verbose]', 'Generate the documentation icon spritesheets' | |
| 14 | + option :remove_public_icons, type: :boolean, desc: 'Remove public/icons after generating the spritesheets' | |
| 15 | + option :verbose, type: :boolean | |
| 16 | + def generate | |
| 17 | + items = get_items | |
| 18 | + items_with_icons = items.select {|item| item[:has_icons]} | |
| 19 | + items_without_icons = items.select {|item| !item[:has_icons]} | |
| 20 | + icons_per_row = Math.sqrt(items_with_icons.length).ceil | |
| 21 | + | |
| 22 | + bg_color = get_sidebar_background | |
| 23 | + | |
| 24 | + items_with_icons.each_with_index do |item, index| | |
| 25 | + item[:row] = (index / icons_per_row).floor | |
| 26 | + item[:col] = index - item[:row] * icons_per_row | |
| 27 | + | |
| 28 | + item[:icon_16] = get_icon(item[:path_16], 16) | |
| 29 | + item[:icon_32] = get_icon(item[:path_32], 32) | |
| 30 | + | |
| 31 | + item[:dark_icon_fix] = needs_dark_icon_fix(item[:icon_32], bg_color) | |
| 32 | + end | |
| 33 | + | |
| 34 | + return unless items_with_icons.length > 0 | |
| 35 | + | |
| 36 | + log_details(items_with_icons, icons_per_row) | |
| 37 | + | |
| 38 | + generate_spritesheet(16, items_with_icons, 'assets/images/sprites/docs.png') {|item| item[:icon_16]} | |
| 39 | + generate_spritesheet(32, items_with_icons, 'assets/images/sprites/docs@2x.png') {|item| item[:icon_32]} | |
| 40 | + | |
| 41 | + # Add Mongoose's icon details to docs without custom icons | |
| 42 | + default_item = items_with_icons.find {|item| item[:type] == 'mongoose'} | |
| 43 | + items_without_icons.each do |item| | |
| 44 | + item[:row] = default_item[:row] | |
| 45 | + item[:col] = default_item[:col] | |
| 46 | + item[:dark_icon_fix] = default_item[:dark_icon_fix] | |
| 47 | + end | |
| 48 | + | |
| 49 | + save_manifest(items, icons_per_row, 'assets/images/sprites/docs.json') | |
| 50 | + | |
| 51 | + if options[:remove_public_icons] | |
| 52 | + logger.info('Removing public/icons') | |
| 53 | + FileUtils.rm_rf('public/icons') | |
| 54 | + end | |
| 55 | + end | |
| 56 | + | |
| 57 | + private | |
| 58 | + | |
| 59 | + def get_items | |
| 60 | + items = Docs.all.map do |doc| | |
| 61 | + base_path = "public/icons/docs/#{doc.slug}" | |
| 62 | + { | |
| 63 | + :type => doc.slug, | |
| 64 | + :path_16 => "#{base_path}/16.png", | |
| 65 | + :path_32 => "#{base_path}/16@2x.png" | |
| 66 | + } | |
| 67 | + end | |
| 68 | + | |
| 69 | + # Checking paths against an array of possible paths is faster than 200+ File.exist? calls | |
| 70 | + files = Dir.glob('public/icons/docs/**/*.png') | |
| 71 | + | |
| 72 | + items.each do |item| | |
| 73 | + item[:has_icons] = files.include?(item[:path_16]) && files.include?(item[:path_32]) | |
| 74 | + end | |
| 75 | + end | |
| 76 | + | |
| 77 | + def get_icon(path, max_size) | |
| 78 | + icon = ChunkyPNG::Image.from_file(path) | |
| 79 | + | |
| 80 | + # Check if the icon is too big | |
| 81 | + # If it is, resize the image without changing the aspect ratio | |
| 82 | + if icon.width > max_size || icon.height > max_size | |
| 83 | + ratio = icon.width.to_f / icon.height | |
| 84 | + new_width = (icon.width >= icon.height ? max_size : max_size * ratio).floor | |
| 85 | + new_height = (icon.width >= icon.height ? max_size / ratio : max_size).floor | |
| 86 | + | |
| 87 | + logger.warn("Icon #{path} is too big: max size is #{max_size} x #{max_size}, icon is #{icon.width} x #{icon.height}, resizing to #{new_width} x #{new_height}") | |
| 88 | + | |
| 89 | + icon.resample_nearest_neighbor!(new_width, new_height) | |
| 90 | + end | |
| 91 | + | |
| 92 | + icon | |
| 93 | + end | |
| 94 | + | |
| 95 | + def get_sidebar_background | |
| 96 | + # This is a hacky way to get the background color of the sidebar | |
| 97 | + # Unfortunately, it's not possible to get the value of a SCSS variable from a Thor task | |
| 98 | + # Because hard-coding the value is even worse, we extract it using some regex | |
| 99 | + path = 'assets/stylesheets/global/_variables-dark.scss' | |
| 100 | + regex = /--sidebarBackground:\s+([^;]+);/ | |
| 101 | + ChunkyPNG::Color.parse(File.read(path)[regex, 1]) | |
| 102 | + end | |
| 103 | + | |
| 104 | + def needs_dark_icon_fix(icon, bg_color) | |
| 105 | + # Determine whether the icon needs to be grayscaled if the user has enabled the dark theme | |
| 106 | + # The logic is roughly based on https://www.w3.org/TR/2008/REC-WCAG20-20081211/#visual-audio-contrast | |
| 107 | + contrast = icon.pixels.select {|pixel| ChunkyPNG::Color.a(pixel) > 0}.map do |pixel| | |
| 108 | + get_contrast(bg_color, pixel) | |
| 109 | + end | |
| 110 | + | |
| 111 | + avg = contrast.reduce(:+) / contrast.size.to_f | |
| 112 | + avg < 3.5 | |
| 113 | + end | |
| 114 | + | |
| 115 | + def get_contrast(base, other) | |
| 116 | + # Calculating the contrast ratio as described in the WCAG 2.0: | |
| 117 | + # https://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef | |
| 118 | + l1 = get_luminance(base) + 0.05 | |
| 119 | + l2 = get_luminance(other) + 0.05 | |
| 120 | + ratio = l1 / l2 | |
| 121 | + l2 > l1 ? 1 / ratio : ratio | |
| 122 | + end | |
| 123 | + | |
| 124 | + def get_luminance(color) | |
| 125 | + rgb = [ | |
| 126 | + ChunkyPNG::Color.r(color).to_f, | |
| 127 | + ChunkyPNG::Color.g(color).to_f, | |
| 128 | + ChunkyPNG::Color.b(color).to_f | |
| 129 | + ] | |
| 130 | + | |
| 131 | + # Calculating the relative luminance as described in the WCAG 2.0: | |
| 132 | + # https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef | |
| 133 | + | |
| 134 | + rgb.map! do |value| | |
| 135 | + value /= 255 | |
| 136 | + value < 0.03928 ? value / 12.92 : ((value + 0.055) / 1.055) ** 2.4 | |
| 137 | + end | |
| 138 | + | |
| 139 | + 0.2126 * rgb[0] + 0.7152 * rgb[1] + 0.0722 * rgb[2] | |
| 140 | + end | |
| 141 | + | |
| 142 | + def generate_spritesheet(size, items_with_icons, output_path, &item_to_icon) | |
| 143 | + logger.info("Generating spritesheet #{output_path} with icons of size #{size} x #{size}") | |
| 144 | + | |
| 145 | + icons_per_row = Math.sqrt(items_with_icons.length).ceil | |
| 146 | + spritesheet = ChunkyPNG::Image.new(size * icons_per_row, size * icons_per_row) | |
| 147 | + | |
| 148 | + items_with_icons.each do |item| | |
| 149 | + icon = item_to_icon.call(item) | |
| 150 | + | |
| 151 | + # Calculate the base coordinates | |
| 152 | + base_x = item[:col] * size | |
| 153 | + base_y = item[:row] * size | |
| 154 | + | |
| 155 | + # Center the icon if it's not a perfect rectangle | |
| 156 | + x = base_x + ((size - icon.width) / 2).floor | |
| 157 | + y = base_y + ((size - icon.height) / 2).floor | |
| 158 | + | |
| 159 | + spritesheet.compose!(icon, x, y) | |
| 160 | + end | |
| 161 | + | |
| 162 | + FileUtils.mkdir_p(File.dirname(output_path)) | |
| 163 | + spritesheet.save(output_path) | |
| 164 | + end | |
| 165 | + | |
| 166 | + def save_manifest(items, icons_per_row, path) | |
| 167 | + logger.info("Saving spritesheet details to #{path}") | |
| 168 | + | |
| 169 | + FileUtils.mkdir_p(File.dirname(path)) | |
| 170 | + | |
| 171 | + # Only save the details that the scss file needs | |
| 172 | + manifest_items = items.map do |item| | |
| 173 | + { | |
| 174 | + :type => item[:type], | |
| 175 | + :row => item[:row], | |
| 176 | + :col => item[:col], | |
| 177 | + :dark_icon_fix => item[:dark_icon_fix] | |
| 178 | + } | |
| 179 | + end | |
| 180 | + | |
| 181 | + manifest = {:icons_per_row => icons_per_row, :items => manifest_items} | |
| 182 | + | |
| 183 | + File.open(path, 'w') do |f| | |
| 184 | + f.write(JSON.generate(manifest)) | |
| 185 | + end | |
| 186 | + end | |
| 187 | + | |
| 188 | + def log_details(items_with_icons, icons_per_row) | |
| 189 | + logger.debug("Amount of icons: #{items_with_icons.length}") | |
| 190 | + logger.debug("Amount of icons needing the dark icon fix: #{items_with_icons.count {|item| item[:dark_icon_fix]}}") | |
| 191 | + logger.debug("Amount of icons per row: #{icons_per_row}") | |
| 192 | + | |
| 193 | + max_type_length = items_with_icons.map {|item| item[:type].length}.max | |
| 194 | + border = "+#{'-' * (max_type_length + 2)}+#{'-' * 5}+#{'-' * 8}+#{'-' * 15}+" | |
| 195 | + | |
| 196 | + logger.debug(border) | |
| 197 | + logger.debug("| #{'Type'.ljust(max_type_length)} | Row | Column | Dark icon fix |") | |
| 198 | + logger.debug(border) | |
| 199 | + | |
| 200 | + items_with_icons.each do |item| | |
| 201 | + logger.debug("| #{item[:type].ljust(max_type_length)} | #{item[:row].to_s.ljust(3)} | #{item[:col].to_s.ljust(6)} | #{(item[:dark_icon_fix] ? 'Yes' : 'No').ljust(13)} |") | |
| 202 | + end | |
| 203 | + | |
| 204 | + logger.debug(border) | |
| 205 | + end | |
| 206 | + | |
| 207 | + def logger | |
| 208 | + @logger ||= Logger.new($stdout).tap do |logger| | |
| 209 | + logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO | |
| 210 | + logger.formatter = proc {|severity, datetime, progname, msg| "#{msg}\n"} | |
| 211 | + end | |
| 212 | + end | |
| 213 | +end | |
| @@ -0,0 +1,315 @@ | ||
| 1 | +class UpdatesCLI < Thor | |
| 2 | + # The GitHub user that is allowed to upload reports | |
| 3 | + UPLOAD_USER = 'devdocs-bot' | |
| 4 | + | |
| 5 | + # The repository to create an issue in when uploading the results | |
| 6 | + UPLOAD_REPO = 'freeCodeCamp/devdocs' | |
| 7 | + | |
| 8 | + def self.to_s | |
| 9 | + 'Updates' | |
| 10 | + end | |
| 11 | + | |
| 12 | + def initialize(*args) | |
| 13 | + require 'docs' | |
| 14 | + require 'progress_bar' | |
| 15 | + require 'terminal-table' | |
| 16 | + require 'date' | |
| 17 | + super | |
| 18 | + end | |
| 19 | + | |
| 20 | + desc 'check [--github-token] [--upload] [--verbose] [doc]...', 'Check for outdated documentations' | |
| 21 | + option :github_token, :type => :string | |
| 22 | + option :upload, :type => :boolean | |
| 23 | + option :verbose, :type => :boolean | |
| 24 | + def check(*names) | |
| 25 | + # Convert names to a list of Scraper instances | |
| 26 | + # Versions are omitted, if v10 is outdated than v8 is aswell | |
| 27 | + docs = names.map {|name| Docs.find(name.split(/@|~/)[0], false)}.uniq | |
| 28 | + | |
| 29 | + # Check all documentations for updates when no arguments are given | |
| 30 | + docs = Docs.all if docs.empty? | |
| 31 | + | |
| 32 | + opts = { | |
| 33 | + logger: logger | |
| 34 | + } | |
| 35 | + | |
| 36 | + if options.key?(:github_token) | |
| 37 | + opts[:github_token] = options[:github_token] | |
| 38 | + end | |
| 39 | + | |
| 40 | + with_progress_bar do |bar| | |
| 41 | + bar.max = docs.length | |
| 42 | + bar.write | |
| 43 | + end | |
| 44 | + | |
| 45 | + results = docs.map do |doc| | |
| 46 | + result = check_doc(doc, opts) | |
| 47 | + with_progress_bar(&:increment!) | |
| 48 | + result | |
| 49 | + end | |
| 50 | + | |
| 51 | + process_results(results) | |
| 52 | + rescue Docs::DocNotFound => error | |
| 53 | + logger.error(error) | |
| 54 | + logger.info('Run "thor docs:list" to see the list of docs.') | |
| 55 | + end | |
| 56 | + | |
| 57 | + private | |
| 58 | + | |
| 59 | + def check_doc(doc, opts) | |
| 60 | + logger.debug("Checking #{doc.name}") | |
| 61 | + | |
| 62 | + instance = doc.versions.first.new | |
| 63 | + scraper_version = instance.get_scraper_version(opts) | |
| 64 | + latest_version = instance.get_latest_version(opts) | |
| 65 | + | |
| 66 | + { | |
| 67 | + name: doc.name, | |
| 68 | + scraper_version: format_version(scraper_version), | |
| 69 | + latest_version: format_version(latest_version), | |
| 70 | + is_outdated: instance.is_outdated(scraper_version, latest_version) | |
| 71 | + } | |
| 72 | + rescue NotImplementedError | |
| 73 | + logger.warn("Couldn't check #{doc.name}, get_latest_version is not implemented") | |
| 74 | + error_result(doc, '`get_latest_version` is not implemented') | |
| 75 | + rescue => error | |
| 76 | + logger.error("Error while checking #{doc.name}\n#{error.full_message.strip}") | |
| 77 | + error_result(doc, error.message.gsub(/'/, '`')) | |
| 78 | + end | |
| 79 | + | |
| 80 | + def format_version(version) | |
| 81 | + str = version.to_s | |
| 82 | + | |
| 83 | + # If the version is numeric and greater than or equal to 1e9 it's probably a timestamp | |
| 84 | + return str if str.match(/^(\d)+$/).nil? or str.to_i < 1e9 | |
| 85 | + | |
| 86 | + DateTime.strptime(str, '%s').strftime('%F') | |
| 87 | + end | |
| 88 | + | |
| 89 | + def error_result(doc, reason) | |
| 90 | + { | |
| 91 | + name: doc.name, | |
| 92 | + error: reason | |
| 93 | + } | |
| 94 | + end | |
| 95 | + | |
| 96 | + def process_results(results) | |
| 97 | + successful_results = results.select {|result| result.key?(:is_outdated)} | |
| 98 | + failed_results = results.select {|result| result.key?(:error)} | |
| 99 | + | |
| 100 | + up_to_date_results = successful_results.select {|result| !result[:is_outdated]} | |
| 101 | + outdated_results = successful_results.select {|result| result[:is_outdated]} | |
| 102 | + | |
| 103 | + log_results(outdated_results, up_to_date_results, failed_results) | |
| 104 | + upload_results(outdated_results, up_to_date_results, failed_results) if options[:upload] | |
| 105 | + end | |
| 106 | + | |
| 107 | + # | |
| 108 | + # Result logging methods | |
| 109 | + # | |
| 110 | + | |
| 111 | + def log_results(outdated_results, up_to_date_results, failed_results) | |
| 112 | + log_failed_results(failed_results) unless failed_results.empty? | |
| 113 | + log_successful_results('Up-to-date', up_to_date_results) unless up_to_date_results.empty? | |
| 114 | + log_successful_results('Outdated', outdated_results) unless outdated_results.empty? | |
| 115 | + end | |
| 116 | + | |
| 117 | + def log_successful_results(label, results) | |
| 118 | + title = "#{label} documentations (#{results.length})" | |
| 119 | + headings = ['Documentation', 'Scraper version', 'Latest version'] | |
| 120 | + rows = results.map {|result| [result[:name], result[:scraper_version], result[:latest_version]]} | |
| 121 | + | |
| 122 | + table = Terminal::Table.new :title => title, :headings => headings, :rows => rows | |
| 123 | + puts table | |
| 124 | + end | |
| 125 | + | |
| 126 | + def log_failed_results(results) | |
| 127 | + title = "Documentations that could not be checked (#{results.length})" | |
| 128 | + headings = %w(Documentation Reason) | |
| 129 | + rows = results.map {|result| [result[:name], result[:error]]} | |
| 130 | + | |
| 131 | + table = Terminal::Table.new :title => title, :headings => headings, :rows => rows | |
| 132 | + puts table | |
| 133 | + end | |
| 134 | + | |
| 135 | + # | |
| 136 | + # Upload methods | |
| 137 | + # | |
| 138 | + | |
| 139 | + def upload_results(outdated_results, up_to_date_results, failed_results) | |
| 140 | + # We can't create issues without a GitHub token | |
| 141 | + unless options.key?(:github_token) | |
| 142 | + logger.error("Please specify a GitHub token with the public_repo permission for #{UPLOAD_USER} with the --github-token parameter") | |
| 143 | + return | |
| 144 | + end | |
| 145 | + | |
| 146 | + logger.info('Uploading the results to a new GitHub issue') | |
| 147 | + | |
| 148 | + logger.info('Checking if the GitHub token belongs to the correct user') | |
| 149 | + user = github_get('/user') | |
| 150 | + | |
| 151 | + # Only allow the DevDocs bot to upload reports | |
| 152 | + unless user['login'] == UPLOAD_USER | |
| 153 | + logger.error("Only #{UPLOAD_USER} is supposed to upload the results to a new issue. The specified github token is not for #{UPLOAD_USER}.") | |
| 154 | + return | |
| 155 | + end | |
| 156 | + | |
| 157 | + logger.info('Creating a new GitHub issue') | |
| 158 | + | |
| 159 | + issue = results_to_issue(outdated_results, up_to_date_results, failed_results) | |
| 160 | + created_issue = github_post("/repos/#{UPLOAD_REPO}/issues", issue) | |
| 161 | + | |
| 162 | + logger.info('Checking if the previous issue is still open') | |
| 163 | + | |
| 164 | + search_params = { | |
| 165 | + q: "Documentation versions report in:title author:#{UPLOAD_USER} is:issue repo:#{UPLOAD_REPO}", | |
| 166 | + sort: 'created', | |
| 167 | + order: 'desc' | |
| 168 | + } | |
| 169 | + | |
| 170 | + matching_issues = github_get('/search/issues', search_params) | |
| 171 | + previous_issue = matching_issues['items'].find {|item| item['number'] != created_issue['number']} | |
| 172 | + | |
| 173 | + if previous_issue.nil? | |
| 174 | + logger.info('No previous issue found') | |
| 175 | + log_upload_success(created_issue) | |
| 176 | + else | |
| 177 | + logger.info('Commenting on the previous issue') | |
| 178 | + | |
| 179 | + comment = "This report was superseded by ##{created_issue['number']}." | |
| 180 | + github_post("/repos/#{UPLOAD_REPO}/issues/#{previous_issue['number']}/comments", {body: comment}) | |
| 181 | + if previous_issue['closed_at'].nil? | |
| 182 | + logger.info('Closing the previous issue') | |
| 183 | + github_patch("/repos/#{UPLOAD_REPO}/issues/#{previous_issue['number']}", {state: 'closed'}) | |
| 184 | + log_upload_success(created_issue) | |
| 185 | + else | |
| 186 | + logger.info('The previous issue has already been closed') | |
| 187 | + log_upload_success(created_issue) | |
| 188 | + end | |
| 189 | + end | |
| 190 | + end | |
| 191 | + | |
| 192 | + def results_to_issue(outdated_results, up_to_date_results, failed_results) | |
| 193 | + results = [ | |
| 194 | + successful_results_to_markdown('Outdated', outdated_results), | |
| 195 | + successful_results_to_markdown('Up-to-date', up_to_date_results), | |
| 196 | + failed_results_to_markdown(failed_results) | |
| 197 | + ] | |
| 198 | + | |
| 199 | + results_str = results.select {|result| !result.nil?}.join("\n\n") | |
| 200 | + travis_str = ENV['TRAVIS'].nil? ? '' : "\n\nThis issue was created by Travis CI build [##{ENV['TRAVIS_BUILD_NUMBER']}](#{ENV['TRAVIS_BUILD_WEB_URL']})." | |
| 201 | + | |
| 202 | + title = "Documentation versions report for #{Date.today.strftime('%B %Y')}" | |
| 203 | + body = <<-MARKDOWN | |
| 204 | +## What is this? | |
| 205 | + | |
| 206 | +This is an automatically created issue which contains information about the version status of the documentations available on DevDocs. The results of this report can be used by maintainers when updating outdated documentations. | |
| 207 | + | |
| 208 | +Maintainers can close this issue when all documentations are up-to-date. The issue is also automatically closed when the next report is created.#{travis_str} | |
| 209 | + | |
| 210 | +## Results | |
| 211 | + | |
| 212 | +The #{outdated_results.length + up_to_date_results.length + failed_results.length} documentations are divided as follows: | |
| 213 | +- #{outdated_results.length} that #{outdated_results.length == 1 ? 'is' : 'are'} outdated | |
| 214 | +- #{up_to_date_results.length} that #{up_to_date_results.length == 1 ? 'is' : 'are'} up-to-date (patch updates are ignored) | |
| 215 | +- #{failed_results.length} that could not be checked | |
| 216 | + MARKDOWN | |
| 217 | + | |
| 218 | + { | |
| 219 | + title: title, | |
| 220 | + body: body.strip + "\n\n" + results_str | |
| 221 | + } | |
| 222 | + end | |
| 223 | + | |
| 224 | + def successful_results_to_markdown(label, results) | |
| 225 | + return nil if results.empty? | |
| 226 | + | |
| 227 | + title = "#{label} documentations (#{results.length})" | |
| 228 | + headings = ['Documentation', 'Scraper version', 'Latest version'] | |
| 229 | + rows = results.map {|result| [result[:name], result[:scraper_version], result[:latest_version]]} | |
| 230 | + | |
| 231 | + results_to_markdown(title, headings, rows) | |
| 232 | + end | |
| 233 | + | |
| 234 | + def failed_results_to_markdown(results) | |
| 235 | + return nil if results.empty? | |
| 236 | + | |
| 237 | + title = "Documentations that could not be checked (#{results.length})" | |
| 238 | + headings = %w(Documentation Reason) | |
| 239 | + rows = results.map {|result| [result[:name], result[:error]]} | |
| 240 | + | |
| 241 | + results_to_markdown(title, headings, rows) | |
| 242 | + end | |
| 243 | + | |
| 244 | + def results_to_markdown(title, headings, rows) | |
| 245 | + "<details>\n<summary>#{title}</summary>\n\n#{create_markdown_table(headings, rows)}\n</details>" | |
| 246 | + end | |
| 247 | + | |
| 248 | + def create_markdown_table(headings, rows) | |
| 249 | + header = headings.join(' | ') | |
| 250 | + separator = '-|' * headings.length | |
| 251 | + body = rows.map {|row| row.join(' | ')} | |
| 252 | + | |
| 253 | + header + "\n" + separator[0...-1] + "\n" + body.join("\n") | |
| 254 | + end | |
| 255 | + | |
| 256 | + def log_upload_success(created_issue) | |
| 257 | + logger.info("Successfully uploaded the results to #{created_issue['html_url']}") | |
| 258 | + end | |
| 259 | + | |
| 260 | + # | |
| 261 | + # HTTP utilities | |
| 262 | + # | |
| 263 | + | |
| 264 | + def github_get(endpoint, params = {}) | |
| 265 | + github_request(endpoint, {method: :get, params: params}) | |
| 266 | + end | |
| 267 | + | |
| 268 | + def github_post(endpoint, params) | |
| 269 | + github_request(endpoint, {method: :post, body: params.to_json}) | |
| 270 | + end | |
| 271 | + | |
| 272 | + def github_patch(endpoint, params) | |
| 273 | + github_request(endpoint, {method: :patch, body: params.to_json}) | |
| 274 | + end | |
| 275 | + | |
| 276 | + def github_request(endpoint, opts) | |
| 277 | + url = "https://api.github.com#{endpoint}" | |
| 278 | + | |
| 279 | + # GitHub token authentication | |
| 280 | + opts[:headers] = { | |
| 281 | + Authorization: "token #{options[:github_token]}" | |
| 282 | + } | |
| 283 | + | |
| 284 | + # GitHub requires the Content-Type to be application/json when a body is passed | |
| 285 | + if opts.key?(:body) | |
| 286 | + opts[:headers]['Content-Type'] = 'application/json' | |
| 287 | + end | |
| 288 | + | |
| 289 | + logger.debug("Making a #{opts[:method]} request to #{url}") | |
| 290 | + response = Docs::Request.run(url, opts) | |
| 291 | + | |
| 292 | + # response.success? is false if the response code is 201 | |
| 293 | + # GitHub returns 201 Created after an issue is created | |
| 294 | + if response.success? || response.code == 201 | |
| 295 | + JSON.parse(response.body) | |
| 296 | + else | |
| 297 | + logger.error("Couldn't make a #{opts[:method]} request to #{url} (response code #{response.code})") | |
| 298 | + nil | |
| 299 | + end | |
| 300 | + end | |
| 301 | + | |
| 302 | + # A utility method which ensures no progress bar is shown when stdout is not a tty | |
| 303 | + def with_progress_bar(&block) | |
| 304 | + return unless $stdout.tty? | |
| 305 | + @progress_bar ||= ::ProgressBar.new | |
| 306 | + block.call @progress_bar | |
| 307 | + end | |
| 308 | + | |
| 309 | + def logger | |
| 310 | + @logger ||= Logger.new($stdout).tap do |logger| | |
| 311 | + logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO | |
| 312 | + logger.formatter = proc {|severity, datetime, progname, msg| "[#{severity}] #{msg}\n"} | |
| 313 | + end | |
| 314 | + end | |
| 315 | +end | |
| @@ -1 +0,0 @@ | ||
| 1 | −[] | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://github.com/composer/getcomposer.org/blob/master/web/img/logo-composer-transparent.png | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file added.
| @@ -0,0 +1 @@ | ||
| 1 | +10 | |
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://github.com/cypress-io/cypress-documentation/raw/develop/themes/cypress/source/img/favicon.ico | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file added.
| @@ -0,0 +1 @@ | ||
| 1 | +10 | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file added.
| @@ -0,0 +1 @@ | ||
| 1 | +10 | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file added.
| @@ -0,0 +1 @@ | ||
| 1 | +10 | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file added.
| @@ -0,0 +1,14 @@ | ||
| 1 | +<?xml version="1.0" encoding="UTF-8"?> | |
| 2 | +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | |
| 3 | +<plist version="1.0"> | |
| 4 | +<dict> | |
| 5 | + <key>app</key> | |
| 6 | + <string>com.bohemiancoding.sketch</string> | |
| 7 | + <key>build</key> | |
| 8 | + <integer>5302</integer> | |
| 9 | + <key>commit</key> | |
| 10 | + <string>9460a4bc62af5e9ba50dd4143578fd9401710ce5</string> | |
| 11 | + <key>version</key> | |
| 12 | + <integer>18</integer> | |
| 13 | +</dict> | |
| 14 | +</plist> | |
| @@ -0,0 +1 @@ | ||
| 1 | +18 | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://github.com/saltstack/salt/blob/develop/doc/_static/salt-logo.svg | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://github.com/vuejs/vuejs.org/blob/master/assets/logo.ai | |
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://github.com/vuejs/vuejs.org/blob/master/assets/logo.ai | |
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1 @@ | ||
| 1 | +https://wordpress.org/about/logos/ | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -0,0 +1,18 @@ | ||
| 1 | +<?xml version="1.0" encoding="UTF-8"?> | |
| 2 | +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | |
| 3 | +<plist version="1.0"> | |
| 4 | +<dict> | |
| 5 | + <key>app</key> | |
| 6 | + <string>com.bohemiancoding.sketch</string> | |
| 7 | + <key>build</key> | |
| 8 | + <integer>5355</integer> | |
| 9 | + <key>commit</key> | |
| 10 | + <string>b7d299b0a34651d1a0e066786b75aa36168d5809</string> | |
| 11 | + <key>fonts</key> | |
| 12 | + <array/> | |
| 13 | + <key>length</key> | |
| 14 | + <integer>22373</integer> | |
| 15 | + <key>version</key> | |
| 16 | + <integer>18</integer> | |
| 17 | +</dict> | |
| 18 | +</plist> | |
| @@ -0,0 +1 @@ | ||
| 1 | +18 | |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
| @@ -4,6 +4,7 @@ · 3 unmodified lines | ||
| 4 | 4 | "description": "API Documentation Browser", |
| 5 | 5 | "start_url": "/", |
| 6 | 6 | "display": "standalone", |
| 7 | + "background_color": "#EEEEEE", | |
| 7 | 8 | "icons": [ |
| 8 | 9 | { |
| 9 | 10 | "src": "/images/webapp-icon-32.png", |
| @@ -25,6 +26,11 @@ · 15 unmodified lines | ||
| 25 | 26 | "sizes": "128x128", |
| 26 | 27 | "type": "image/png" |
| 27 | 28 | }, |
| 29 | + { | |
| 30 | + "src": "/images/webapp-icon-192.png", | |
| 31 | + "sizes": "192x192", | |
| 32 | + "type": "image/png" | |
| 33 | + }, | |
| 28 | 34 | { |
| 29 | 35 | "src": "/images/webapp-icon-256.png", |
| 30 | 36 | "sizes": "256x256", |
| @@ -43,35 +43,6 @@ class AppTest < MiniTest::Spec · 42 unmodified lines | ||
| 43 | 43 | assert last_response.redirect? |
| 44 | 44 | assert_equal 'https://example.org/', last_response['Location'] |
| 45 | 45 | end |
| 46 | − | |
| 47 | − it "sets default size" do | |
| 48 | − get '/' | |
| 49 | − assert_includes last_response.body, 'data-size="20rem"' | |
| 50 | − end | |
| 51 | − | |
| 52 | − it "sets size from cookie" do | |
| 53 | − set_cookie('size=42') | |
| 54 | − get '/' | |
| 55 | − assert_includes last_response.body, 'data-size="42px"' | |
| 56 | − end | |
| 57 | − | |
| 58 | − it "sets layout from cookie" do | |
| 59 | − set_cookie('layout=foo') | |
| 60 | − get '/' | |
| 61 | − assert_includes last_response.body, '<body class="foo">' | |
| 62 | − end | |
| 63 | − | |
| 64 | − it "sets the <html> theme from cookie" do | |
| 65 | − get '/' | |
| 66 | − assert_match %r{<html [^>]*class="[^\"]*_theme-default}, last_response.body | |
| 67 | − refute_includes last_response.body, '_theme-dark' | |
| 68 | − | |
| 69 | − set_cookie('dark=1') | |
| 70 | − | |
| 71 | − get '/' | |
| 72 | − assert_match %r{<html [^>]*class="[^\"]*_theme-dark}, last_response.body | |
| 73 | − refute_includes last_response.body, '_theme-default' | |
| 74 | − end | |
| 75 | 46 | end |
| 76 | 47 | |
| 77 | 48 | describe "/[static-page]" do |
| @@ -106,58 +77,6 @@ class AppTest < MiniTest::Spec · 28 unmodified lines | ||
| 106 | 77 | end |
| 107 | 78 | end |
| 108 | 79 | |
| 109 | − describe "/manifest.appcache" do | |
| 110 | − it "works" do | |
| 111 | − get '/manifest.appcache' | |
| 112 | − assert last_response.ok? | |
| 113 | − end | |
| 114 | − | |
| 115 | − it "works with cookie" do | |
| 116 | − set_cookie('docs=css/html~5') | |
| 117 | − get '/manifest.appcache' | |
| 118 | − assert last_response.ok? | |
| 119 | − assert_includes last_response.body, '/css/index.json?1420139788' | |
| 120 | − assert_includes last_response.body, '/html~5/index.json?1420139791' | |
| 121 | − end | |
| 122 | − | |
| 123 | − it "ignores invalid docs in the cookie" do | |
| 124 | − set_cookie('docs=foo') | |
| 125 | − get '/manifest.appcache' | |
| 126 | − assert last_response.ok? | |
| 127 | − refute_includes last_response.body, 'foo' | |
| 128 | − end | |
| 129 | − | |
| 130 | − it "has the word 'default' when no 'dark' cookie is set" do | |
| 131 | − get '/manifest.appcache' | |
| 132 | − assert_includes last_response.body, '# default' | |
| 133 | − refute_includes last_response.body, '# dark' | |
| 134 | − end | |
| 135 | − | |
| 136 | − it "has the word 'dark' when the cookie is set" do | |
| 137 | − set_cookie('dark=1') | |
| 138 | − get '/manifest.appcache' | |
| 139 | − assert_includes last_response.body, '# dark' | |
| 140 | − refute_includes last_response.body, '# default' | |
| 141 | − end | |
| 142 | − | |
| 143 | − it "sets default size" do | |
| 144 | − get '/manifest.appcache' | |
| 145 | − assert_includes last_response.body, '20rem' | |
| 146 | − end | |
| 147 | − | |
| 148 | − it "sets size from cookie" do | |
| 149 | − set_cookie('size=42') | |
| 150 | − get '/manifest.appcache' | |
| 151 | − assert_includes last_response.body, '42px' | |
| 152 | − end | |
| 153 | − | |
| 154 | − it "sets layout from cookie" do | |
| 155 | − set_cookie('layout=foo_layout') | |
| 156 | − get '/manifest.appcache' | |
| 157 | − assert_includes last_response.body, 'foo_layout' | |
| 158 | − end | |
| 159 | − end | |
| 160 | − | |
| 161 | 80 | describe "/[doc]" do |
| 162 | 81 | it "renders when the doc exists and isn't enabled" do |
| 163 | 82 | set_cookie('docs=html~5') |
| @@ -63,7 +63,7 @@ class FileScraperTest < MiniTest::Spec · 62 unmodified lines | ||
| 63 | 63 | end |
| 64 | 64 | |
| 65 | 65 | it "reads a file" do |
| 66 | − mock(scraper).read_file(path) | |
| 66 | + mock(scraper).read_file(File.join(ROOT_PATH, 'docs/scraper', path)) | |
| 67 | 67 | result |
| 68 | 68 | end |
| 69 | 69 | |
| @@ -165,7 +165,7 @@ class FileScraperTest < MiniTest::Spec · 95 unmodified lines | ||
| 165 | 165 | |
| 166 | 166 | describe "#read_file" do |
| 167 | 167 | let :result do |
| 168 | − scraper.send :read_file, 'file' | |
| 168 | + scraper.send :read_file, File.join(ROOT_PATH, 'docs', 'scraper', 'file') | |
| 169 | 169 | end |
| 170 | 170 | |
| 171 | 171 | it "returns the file's content when the file exists in the source directory" do |
| @@ -28,13 +28,7 @@ · 27 unmodified lines | ||
| 28 | 28 | </nav> |
| 29 | 29 | </header> |
| 30 | 30 | <section class="_sidebar" tabindex="-1"> |
| 31 | − <div class="_list" role="navigation"> | |
| 32 | − <% unless @doc %> | |
| 33 | − <% App.docs.each do |slug, doc| %> | |
| 34 | − <a href="/<%= slug %>/" class="_list-item"><%= doc['full_name'] %></a> | |
| 35 | − <% end %> | |
| 36 | − <% end %> | |
| 37 | − </div> | |
| 31 | + <div class="_list" role="navigation"></div> | |
| 38 | 32 | </section> |
| 39 | 33 | <div class="_container" role="document"> |
| 40 | 34 | <main class="_content _content-loading" role="main"></main> |
| @@ -63,9 +57,3 @@ · 22 unmodified lines | ||
| 63 | 57 | <symbol id="icon-external-link" viewBox="0 0 24 24"><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></symbol> |
| 64 | 58 | </defs> |
| 65 | 59 | </svg> |
| 66 | −<style data-size="<%= app_size %>" data-resizer> | |
| 67 | − ._container { margin-left: <%= app_size %>; } | |
| 68 | − ._header, ._list { width: <%= app_size %>; } | |
| 69 | − ._list-hover.clone { min-width: <%= app_size %>; } | |
| 70 | − ._notice, ._path, ._resizer { left: <%= app_size %>; } | |
| 71 | −</style> | |
| @@ -1,5 +1,5 @@ | ||
| 1 | 1 | <!DOCTYPE html> |
| 2 | −<html<%= ' manifest="/manifest.appcache"' if App.production? %> prefix="og: http://ogp.me/ns#" lang="en" class="_booting _theme-<%= app_theme %>"> | |
| 2 | +<html prefix="og: http://ogp.me/ns#" lang="en" class="_booting"> | |
| 3 | 3 | <head> |
| 4 | 4 | <meta charset="utf-8"> |
| 5 | 5 | <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no,shrink-to-fit=no"> |
| @@ -14,6 +14,7 @@ · 8 unmodified lines | ||
| 14 | 14 | <meta name="apple-mobile-web-app-capable" content="yes"> |
| 15 | 15 | <meta name="apple-mobile-web-app-status-bar-style" content="black"> |
| 16 | 16 | <meta name="format-detection" content="telephone=no"> |
| 17 | + <meta name="theme-color" content="#eee"> | |
| 17 | 18 | <meta name="robots" content="noodp"> |
| 18 | 19 | <title>DevDocs API Documentation</title> |
| 19 | 20 | <link rel="canonical" href="<%= canonical_origin %>"> |
| @@ -32,7 +33,7 @@ · 12 unmodified lines | ||
| 32 | 33 | <link rel="mask-icon" href="<%= App.cdn_origin %>/images/webkit-mask-icon.svg" color="#398df0"> |
| 33 | 34 | <%= stylesheet_tag 'application' %> |
| 34 | 35 | </head> |
| 35 | −<body<%= %( class="#{app_layout}") if app_layout %>> | |
| 36 | +<body> | |
| 36 | 37 | <noscript class="_fail">DevDocs requires JavaScript to run.</noscript> |
| 37 | 38 | <%= erb :app -%> |
| 38 | 39 | <%= javascript_tag 'application', asset_host: false %> |
| @@ -1,14 +0,0 @@ | ||
| 1 | −CACHE MANIFEST | |
| 2 | −# <%= app_theme %> <%= app_size %> <%= app_layout %> | |
| 3 | − | |
| 4 | −CACHE: | |
| 5 | −/ | |
| 6 | −<%= manifest_asset_urls.join "\n" %> | |
| 7 | −<%= doc_index_urls.join "\n" %> | |
| 8 | − | |
| 9 | −NETWORK: | |
| 10 | −/s/ | |
| 11 | −* | |
| 12 | − | |
| 13 | −FALLBACK: | |
| 14 | −/ / | |
| @@ -1,10 +1,11 @@ | ||
| 1 | 1 | <!DOCTYPE html> |
| 2 | −<html lang="en" class="_booting _theme-<%= app_theme %>"> | |
| 2 | +<html lang="en" class="_booting"> | |
| 3 | 3 | <head> |
| 4 | 4 | <meta charset="utf-8"> |
| 5 | 5 | <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"> |
| 6 | 6 | <% if doc_index_page? %><meta name="description" content="<%= @doc['name'] %> <%= @doc['release'] %> API documentation with instant search, offline support, keyboard shortcuts, mobile version, and more."><% else %><meta name="robots" content="noindex"><% end %> |
| 7 | 7 | <meta name="format-detection" content="telephone=no"> |
| 8 | + <meta name="theme-color" content="#eee"> | |
| 8 | 9 | <meta property="og:image" content="<%= App.cdn_origin %>/images/icon-320.png"> |
| 9 | 10 | <title>DevDocs<%= " — #{@doc['full_name']} documentation" if doc_index_page? %></title> |
| 10 | 11 | <link rel="canonical" href="<%= canonical_origin %><%= request.path %>"> |
| @@ -13,7 +14,7 @@ · 2 unmodified lines | ||
| 13 | 14 | <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Search DevDocs"> |
| 14 | 15 | <%= stylesheet_tag 'application' %> |
| 15 | 16 | </head> |
| 16 | −<body<%= %( class="#{app_layout}") if app_layout %> data-doc="<%= CGI::escape_html @doc.to_json %>"> | |
| 17 | +<body data-doc="<%= CGI::escape_html @doc.to_json %>"> | |
| 17 | 18 | <noscript class="_fail">DevDocs requires JavaScript to run.</noscript> |
| 18 | 19 | <%= erb :app -%> |
| 19 | 20 | <%= javascript_tag 'application', asset_host: false %><% unless App.production? %> |
| @@ -0,0 +1,61 @@ | ||
| 1 | +<%# The name of the cache to store responses in %> | |
| 2 | +<%# If the cache name changes DevDocs is assumed to be updated %> | |
| 3 | +const cacheName = '<%= service_worker_cache_name %>'; | |
| 4 | + | |
| 5 | +<%# Url's to cache when the service worker is installed %> | |
| 6 | +const urlsToCache = [ | |
| 7 | + '/', | |
| 8 | + '/favicon.ico', | |
| 9 | + '/manifest.json', | |
| 10 | + '<%= service_worker_asset_urls.join "',\n '" %>', | |
| 11 | + '<%= doc_index_urls.join "',\n '" %>', | |
| 12 | +]; | |
| 13 | + | |
| 14 | +<%# Set-up the cache %> | |
| 15 | +self.addEventListener('install', event => { | |
| 16 | + self.skipWaiting(); | |
| 17 | + | |
| 18 | + event.waitUntil( | |
| 19 | + caches.open(cacheName).then(cache => cache.addAll(urlsToCache)), | |
| 20 | + ); | |
| 21 | +}); | |
| 22 | + | |
| 23 | +<%# Remove old caches %> | |
| 24 | +self.addEventListener('activate', event => { | |
| 25 | + event.waitUntil((async () => { | |
| 26 | + const keys = await caches.keys(); | |
| 27 | + const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve()); | |
| 28 | + return Promise.all(jobs); | |
| 29 | + })()); | |
| 30 | +}); | |
| 31 | + | |
| 32 | +<%# Handle HTTP requests %> | |
| 33 | +self.addEventListener('fetch', event => { | |
| 34 | + event.respondWith((async () => { | |
| 35 | + const cachedResponse = await caches.match(event.request); | |
| 36 | + if (cachedResponse) return cachedResponse; | |
| 37 | + | |
| 38 | + try { | |
| 39 | + const response = await fetch(event.request); | |
| 40 | + | |
| 41 | + if (!response.ok) { | |
| 42 | + throw new Error(`The HTTP request failed with status code ${response.status}`); | |
| 43 | + } | |
| 44 | + | |
| 45 | + return response; | |
| 46 | + } catch (err) { | |
| 47 | + const url = new URL(event.request.url); | |
| 48 | + | |
| 49 | + <%# Attempt to return the index page from the cache if the user is visiting a url like devdocs.io/offline or devdocs.io/javascript/global_objects/array/find %> | |
| 50 | + <%# The index page will make sure the correct documentation or a proper offline page is shown %> | |
| 51 | + const pathname = url.pathname; | |
| 52 | + const filename = pathname.substr(1 + pathname.lastIndexOf('/')).split(/\#|\?/g)[0]; | |
| 53 | + if (url.origin === location.origin && !filename.includes('.')) { | |
| 54 | + const cachedIndex = await caches.match('/'); | |
| 55 | + if (cachedIndex) return cachedIndex; | |
| 56 | + } | |
| 57 | + | |
| 58 | + throw err; | |
| 59 | + } | |
| 60 | + })()); | |
| 61 | +}); | |
| @@ -11,16 +11,16 @@ · 10 unmodified lines | ||
| 11 | 11 | <p class="_fail-text">DevDocs is an API documentation browser which supports the following browsers:</p> |
| 12 | 12 | <ul class="_fail-list"> |
| 13 | 13 | <li>Recent versions of Firefox, Chrome, or Opera</li> |
| 14 | − <li>Safari 9.1+</li> | |
| 15 | − <li>Edge 16+</li> | |
| 16 | − <li>iOS 10+</li> | |
| 14 | + <li>Safari 11.1+</li> | |
| 15 | + <li>Edge 17+</li> | |
| 16 | + <li>iOS 11.3+</li> | |
| 17 | 17 | </ul> |
| 18 | 18 | <p class="_fail-text"> |
| 19 | − If you're unable to upgrade, I apologize. | |
| 20 | − I decided to prioritize speed and new features over support for older browsers. | |
| 19 | + If you're unable to upgrade, we apologize. | |
| 20 | + We decided to prioritize speed and new features over support for older browsers. | |
| 21 | 21 | </p> |
| 22 | 22 | <p class="_fail-text"> |
| 23 | − — Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a> | |
| 23 | + — <a href="https://twitter.com/DevDocs">@DevDocs</a> | |
| 24 | 24 | </p> |
| 25 | 25 | </div> |
| 26 | 26 | </body> |
