js-org/js.org

★ 5,758JavaScriptAudience · developerComplexity · 1/5Setup · easy

Mindmap

mindmap
  root((JS.ORG))
    What it does
      Free JS subdomains
      Custom URLs for GitHub Pages
      Community maintained
    How it works
      Pull request to add record
      Cloudflare DNS routing
      Approval within 24 hours
    Requirements
      JavaScript ecosystem only
      Real content required
      No blank placeholders
    Tech
      Cloudflare DNS
      GitHub Pages compatible
      Open subdomain list file

mindmap root((JS.ORG)) What it does Free JS subdomains Custom URLs for GitHub Pages Community maintained How it works Pull request to add record Cloudflare DNS routing Approval within 24 hours Requirements JavaScript ecosystem only Real content required No blank placeholders Tech Cloudflare DNS GitHub Pages compatible Open subdomain list file

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Get a short professional URL like mylibrary.js.org for your open-source npm package or GitHub Pages site instead of the long github.io default

USE CASE 2

Replace a long github.io address with a branded address for a JavaScript developer tool or community resource

Tech stack

JavaScriptCloudflareGitHub Pages

Getting it running

Difficulty · easy Time to first run · 30min

Requires opening a pull request to the js.org repo, approval and DNS propagation take up to 24 hours.

In plain English

JS.ORG is a free subdomain service for JavaScript developers. If you have a project page hosted on GitHub Pages, or a site hosted elsewhere, you can apply to get a short address in the format yourname.js.org instead of the longer default GitHub Pages URL. The service has been running since 2015 and is used by thousands of JavaScript projects and tools. Getting a subdomain involves four steps. First, you set up your GitHub Pages site or another hosting provider. Then you choose the subdomain name you want, typically based on your GitHub username or repository name. Next, you configure your site to use the custom domain by adding a special file or updating your repository settings. Finally, you open a pull request on this repository to add your chosen name to the active subdomains list. The new address usually goes live within 24 hours once the pull request is approved. There are content requirements. Sites hosted on JS.ORG subdomains must be directly related to the JavaScript ecosystem, such as an open-source package, a developer tool, or a community resource. Personal portfolios and unrelated projects are not accepted. Pages must have real content and cannot be blank placeholders or simple redirects away from the domain. The DNS routing that makes all this work is provided by Cloudflare, which the README credits for supporting the project on a generous free plan. This repository is not a software application. The main file it maintains is a list of active subdomain records, and the project is sustained by community pull requests. If you are a JavaScript developer who wants a clean, recognizable URL for a library or tool you maintain, this is a straightforward way to get one at no cost.

Copy-paste prompts

Prompt 1

I have a GitHub Pages site for my JavaScript library. Walk me through the exact steps to apply for a js.org subdomain, including what CNAME file to add and how to format the pull request.

Prompt 2

What content requirements must my site meet before I can apply for a js.org subdomain? Give me a checklist of what is and is not allowed.

Prompt 3

I submitted a pull request to js-org/js.org to add my subdomain but it has not been merged yet. What should I check and how long does approval typically take?

Open on GitHub → Explain another repo

← js-org on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.