[pull] main from freeCodeCamp:main

.github/workflows/build.yml

@@ -13,13 +13,13 @@ jobs:
     steps:
     - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
     - name: Set up Ruby
-      uses: ruby/setup-ruby@d781c1b4ed31764801bfae177617bb0446f5ef8d # v1.218.0
+      uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
       with:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
     - name: Deploy to Heroku
-      uses: akhileshns/heroku-deploy@581dd286c962b6972d427fcf8980f60755c15520 # v3.13.15
+      uses: akhileshns/heroku-deploy@e3eb99d45a8e2ec5dca08735e089607befa4bf28 # v3.14.15
       with:
         heroku_api_key: ${{secrets.HEROKU_API_KEY}}
         heroku_app_name: "devdocs"

.github/workflows/docker-build.yml

@@ -29,15 +29,15 @@ jobs:
           persist-credentials: false
 
       - name: Log in to the Container registry
-        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Extract metadata for Docker
         id: meta
-        uses: docker/metadata-action@369eb591f429131d6889c46b94e711f089e6ca96 # v5
+        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |

.github/workflows/schedule-doc-report.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
     - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
     - name: Set up Ruby
-      uses: ruby/setup-ruby@d781c1b4ed31764801bfae177617bb0446f5ef8d # v1.218.0
+      uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
       with:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Generate report

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Set up Ruby
-      uses: ruby/setup-ruby@d781c1b4ed31764801bfae177617bb0446f5ef8d # v1.218.0
+      uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
       with:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests

.ruby-version

@@ -1 +1 @@
-3.4.1
+3.4.2

.tool-versions

@@ -1 +1 @@
-ruby 3.4.1
+ruby 3.4.2

Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.4.1
+FROM ruby:3.4.2
 ENV LANG=C.UTF-8
 ENV ENABLE_SERVICE_WORKER=true
 

Dockerfile-alpine

@@ -1,4 +1,4 @@
-FROM ruby:3.4.1-alpine
+FROM ruby:3.4.2-alpine
 
 ENV LANG=C.UTF-8
 ENV ENABLE_SERVICE_WORKER=true

Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '3.4.1'
+ruby '3.4.2'
 
 gem 'activesupport', require: false
 gem 'html-pipeline'

Gemfile.lock

@@ -21,7 +21,7 @@ GEM
       rouge (>= 1.0.0)
     bigdecimal (3.1.8)
     browser (5.3.1)
-    byebug (11.1.3)
+    byebug (12.0.0)
     chunky_png (1.4.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
@@ -56,29 +56,29 @@ GEM
     in_threads (1.6.0)
     io-console (0.8.0)
     logger (1.6.2)
-    method_source (1.0.0)
+    method_source (1.1.0)
     mini_portile2 (2.8.8)
-    minitest (5.25.4)
+    minitest (5.25.5)
     multi_json (1.15.0)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     newrelic_rpm (8.16.0)
-    nokogiri (1.18.2)
+    nokogiri (1.18.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     options (2.3.2)
     progress (3.6.0)
     progress_bar (1.3.4)
       highline (>= 1.6)
       options (~> 2.3.0)
-    pry (0.14.2)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
     racc (1.8.1)
-    rack (2.2.10)
+    rack (2.2.13)
     rack-protection (3.2.0)
       base64 (>= 0.1.0)
       rack (~> 2.2, >= 2.2.4)
@@ -89,12 +89,12 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    redcarpet (3.6.0)
+    redcarpet (3.6.1)
     reline (0.6.0)
       io-console (~> 0.5)
     rexml (3.3.9)
     rouge (1.11.1)
-    rr (3.1.1)
+    rr (3.1.2)
     rss (0.3.1)
       rexml
     ruby2_keywords (0.0.5)
@@ -191,7 +191,7 @@ DEPENDENCIES
   yajl-ruby
 
 RUBY VERSION
-   ruby 3.4.1p0
+   ruby 3.4.2p28
 
 BUNDLED WITH
    2.4.6

README.md

@@ -46,7 +46,7 @@ docker run --name devdocs -d -p 9292:9292 devdocs
 
 DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
 
-DevDocs requires Ruby 3.3.0 (defined in [`Gemfile`](./Gemfile)), libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
+DevDocs requires Ruby 3.4.1 (defined in [`Gemfile`](./Gemfile)), 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:
 
 ```sh
 git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs

assets/javascripts/app/settings.js

@@ -16,6 +16,7 @@ app.Settings = class Settings {
     "autoInstall",
     "spaceScroll",
     "spaceTimeout",
+    "noDocSpecificIcon",
   ];
 
   static INTERNAL_KEYS = ["count", "schema", "version", "news"];
@@ -38,6 +39,7 @@ app.Settings = class Settings {
     theme: "auto",
     spaceScroll: 1,
     spaceTimeout: 0.5,
+    noDocSpecificIcon: false,
   };
 
   constructor() {

assets/javascripts/lib/favicon.js

@@ -19,7 +19,7 @@ const withImage = function (url, action) {
 };
 
 this.setFaviconForDoc = function (doc) {
-  if (currentSlug === doc.slug) {
+  if (currentSlug === doc.slug || app.settings.get("noDocSpecificIcon")) {
     return;
   }
 

assets/javascripts/lib/util.js

@@ -457,13 +457,13 @@ $.noop = function () {};
 
 $.popup = function (value) {
   try {
+    window.open(value.href || value, "_blank", "noopener");
+  } catch (error) {
     const win = window.open();
     if (win.opener) {
       win.opener = null;
     }
     win.location = value.href || value;
-  } catch (error) {
-    window.open(value.href || value, "_blank");
   }
 };
 
@@ -526,21 +526,3 @@ $.highlight = function (el, options) {
   el.classList.add(options.className);
   setTimeout(() => el.classList.remove(options.className), options.delay);
 };
-
-$.copyToClipboard = function (string) {
-  let result;
-  const textarea = document.createElement("textarea");
-  textarea.style.position = "fixed";
-  textarea.style.opacity = 0;
-  textarea.value = string;
-  document.body.appendChild(textarea);
-  try {
-    textarea.select();
-    result = !!document.execCommand("copy");
-  } catch (error) {
-    result = false;
-  } finally {
-    document.body.removeChild(textarea);
-  }
-  return result;
-};

assets/javascripts/news.json

@@ -1,4 +1,12 @@
 [
+  [
+    "2025-02-23",
+    "New documentation: <a href=\"/threejs/\">Three.js</a>"
+  ],
+  [
+    "2025-02-16",
+    "New documentation: <a href=\"/openlayers/\">OpenLayers</a>"
+  ],
   [
     "2024-11-23",
     "New documentation: <a href=\"/duckdb/\">DuckDB</a>"

assets/javascripts/templates/pages/settings_tmpl.js

@@ -66,6 +66,12 @@ app.templates.settingsPage = (settings) => `\
       }>Enable tracking cookies
       <small>With this checked, we enable Google Analytics and Gauges to collect anonymous traffic information.</small>
     </label>
+    <label class="_settings-label _hide-on-mobile">
+      <input type="checkbox" form="settings" name="noDocSpecificIcon"${
+        settings.noDocSpecificIcon ? " checked" : ""
+      }>Disable Language-specific Doc Favicons
+      <small>With this checked, we will display the default DevDocs icon for all pages.</small>
+    </label>
   </div>
 </div>
 

assets/javascripts/views/content/entry_page.js

@@ -96,16 +96,9 @@ app.views.EntryPage = class EntryPage extends app.View {
       return content;
     }
 
-    const links = (() => {
-      const result = [];
-      for (var link in this.entry.doc.links) {
-        var url = this.entry.doc.links[link];
-        result.push(
-          `<a href="${url}" class="_links-link">${EntryPage.LINKS[link]}</a>`,
-        );
-      }
-      return result;
-    })();
+    const links = Object.entries(this.entry.doc.links).map(([link, url]) => {
+      return `<a href="${url}" class="_links-link">${EntryPage.LINKS[link]}</a>`;
+    });
 
     return `<p class="_links">${links.join("")}</p>${content}`;
   }
@@ -203,8 +196,8 @@ app.views.EntryPage = class EntryPage extends app.View {
   }
 
   restore() {
-    let path;
-    if (this.cacheMap[(path = this.entry.filePath())]) {
+    const path = this.entry.filePath();
+    if (this.cacheMap[[path]]) {
       this.render(this.cacheMap[path], true);
       return true;
     }
@@ -217,27 +210,26 @@ app.views.EntryPage = class EntryPage extends app.View {
       this.load();
     } else if (target.classList.contains("_pre-clip")) {
       $.stopEvent(event);
-      target.classList.add(
-        $.copyToClipboard(target.parentNode.textContent)
-          ? "_pre-clip-success"
-          : "_pre-clip-error",
+      navigator.clipboard.writeText(target.parentNode.textContent).then(
+        () => target.classList.add("_pre-clip-success"),
+        () => target.classList.add("_pre-clip-error"),
       );
       setTimeout(() => (target.className = "_pre-clip"), 2000);
     }
   }
 
   onAltC() {
-    let link;
-    if (!(link = this.find("._attribution:last-child ._attribution-link"))) {
+    const link = this.find("._attribution:last-child ._attribution-link");
+    if (!link) {
       return;
     }
     console.log(link.href + location.hash);
     navigator.clipboard.writeText(link.href + location.hash);
   }
 
   onAltO() {
-    let link;
-    if (!(link = this.find("._attribution:last-child ._attribution-link"))) {
+    const link = this.find("._attribution:last-child ._attribution-link");
+    if (!link) {
       return;
     }
     this.delay(() => $.popup(link.href + location.hash));

assets/javascripts/views/content/settings_page.js

@@ -20,6 +20,7 @@ app.views.SettingsPage = class SettingsPage extends app.View {
     settings.analyticsConsent = app.settings.get("analyticsConsent");
     settings.spaceScroll = app.settings.get("spaceScroll");
     settings.spaceTimeout = app.settings.get("spaceTimeout");
+    settings.noDocSpecificIcon = app.settings.get("noDocSpecificIcon");
     settings.autoSupported = app.settings.autoSupported;
     for (var layout of app.Settings.LAYOUTS) {
       settings[layout] = app.settings.hasLayout(layout);

assets/stylesheets/application.css.scss

@@ -97,6 +97,7 @@
         'pages/nushell',
         'pages/octave',
         'pages/openjdk',
+        'pages/openlayers',
         'pages/perl',
         'pages/phalcon',
         'pages/phaser',

assets/stylesheets/pages/_openlayers.scss

@@ -0,0 +1,10 @@
+._openlayers {
+  @extend %simple;
+  .nameContainer {
+    @extend %block-label;
+    > * { display: inline-block; margin: 0; }
+    > .tag-source { float: right; }
+  }
+  .card { @extend %box; margin-bottom: 1rem; padding: 1rem; }
+  .signature, .type-signature { @extend %code; }
+}

docs/file-scrapers.md

@@ -300,3 +300,18 @@ it to `docs/sqlite`
 ```sh
 curl https://sqlite.org/2022/sqlite-doc-3400000.zip | bsdtar --extract --file - --directory=docs/sqlite/ --strip-components=1
 ```
+
+## Three.js
+Download the docs from https://github.com/mrdoob/three.js/tree/dev/files or run the following commands in your terminal:
+Make sure to set the version per the release tag (e.g. r160). Note that the r prefix is already included, only the version number is needed.
+
+```sh
+curl https://codeload.github.com/mrdoob/three.js/tar.gz/refs/tags/r${VERSION} > threejs.tar.gz
+tar -xzf threejs.tar.gz
+mkdir -p docs/threejs~${VERSION}
+mv three.js-r${VERSION}/list.json tmp/list.json
+mv three.js-r${VERSION}/docs/* docs/threejs~${VERSION}/
+
+rm -rf three.js-r${VERSION}/
+rm threejs.tar.gz
+```

lib/docs.rb

@@ -112,31 +112,31 @@ def self.aliases
     {
       'angular' => 'ng',
       'angular.js' => 'ng',
-      'backbone.js' => 'bb',
-      'c++' => 'cpp',
+      'backbone' => 'bb',
+      'cpp' => 'c++',
       'coffeescript' => 'cs',
       'crystal' => 'cr',
       'elixir' => 'ex',
       'javascript' => 'js',
       'julia' => 'jl',
       'jquery' => '$',
-      'knockout.js' => 'ko',
+      'knockout' => 'ko',
       'kubernetes' => 'k8s',
       'less' => 'ls',
       'lodash' => '_',
-      'löve' => 'love',
+      'love' => 'löve',
       'marionette' => 'mn',
       'markdown' => 'md',
       'matplotlib' => 'mpl',
       'modernizr' => 'mdr',
-      'moment.js' => 'mt',
+      'moment' => 'mt',
       'openjdk' => 'java',
       'nginx' => 'ngx',
       'numpy' => 'np',
       'pandas' => 'pd',
       'postgresql' => 'pg',
       'python' => 'py',
-      'ruby.on.rails' => 'ror',
+      'rails' => 'ror',
       'ruby' => 'rb',
       'rust' => 'rs',
       'sass' => 'scss',