{"id":26023093,"url":"https://github.com/litilexuezha/mdn-docs-desktop","last_synced_at":"2026-04-22T10:31:09.391Z","repository":{"id":53095654,"uuid":"465238517","full_name":"LitileXueZha/MDN-Docs-Desktop","owner":"LitileXueZha","description":"Delightful offline MDN docs viewer","archived":false,"fork":false,"pushed_at":"2023-05-02T23:06:47.000Z","size":1219,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-05T04:02:07.506Z","etag":null,"topics":["desktop","mdn","mdn-docs","nodejs","web"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LitileXueZha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-02T09:27:24.000Z","updated_at":"2024-01-08T04:47:22.000Z","dependencies_parsed_at":"2023-01-22T23:15:57.790Z","dependency_job_id":null,"html_url":"https://github.com/LitileXueZha/MDN-Docs-Desktop","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/LitileXueZha/MDN-Docs-Desktop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitileXueZha%2FMDN-Docs-Desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitileXueZha%2FMDN-Docs-Desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitileXueZha%2FMDN-Docs-Desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitileXueZha%2FMDN-Docs-Desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LitileXueZha","download_url":"https://codeload.github.com/LitileXueZha/MDN-Docs-Desktop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LitileXueZha%2FMDN-Docs-Desktop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32132041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T08:34:57.708Z","status":"ssl_error","status_checked_at":"2026-04-22T08:34:55.583Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["desktop","mdn","mdn-docs","nodejs","web"],"created_at":"2025-03-06T10:40:06.558Z","updated_at":"2026-04-22T10:31:09.377Z","avatar_url":"https://github.com/LitileXueZha.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Screenshot Index](docs/screenshot.png)\r\n\r\n# MDN Docs Desktop\r\n\r\nDelightful offline MDN docs viewer. And also built-in Node.js official documentation.\r\n\r\n## Install\r\n\r\n1. Install electron\r\n2. Download `app.asar`\r\n\r\nI'm too lazy to create application package for different platform, so you need to download Electron's [prebuilt binaries](https://github.com/electron/electron/releases).\r\n\r\nDownload `app.asar` from latest [releases](https://github.com/LitileXueZha/MDN-Docs-Desktop/releases), then put it into your electron install directory `resources/app`. **Make sure** your downloaded electron version is matched with the released `app.asar` required version.\r\n\r\nThen you can try the optional step, [Customization](#customization).\r\n\r\nHappy for using ~~~\r\n\r\n## About\r\n\r\nMDN web docs 是一个共建的网络学习平台，多年来一直是查询文档标准的好地方，其内容托管在 Github 仓库 [content](https://github.com/mdn/content) 和翻译仓库 [translated-content](https://github.com/mdn/translated-content) 上，主要由 Mozilla 进行托管和维护。\r\n\r\n2022/03/01, Mozilla 发布了 [A new year, a new MDN](https://hacks.mozilla.org/2022/03/a-new-year-a-new-mdn/)，一个奇怪的 logo，糟糕体验的交互和排版设计，还有随后将会推出的 Plus 版本 😰😨😱\r\n\r\nMDN Docs Desktop 是一个离线的文档浏览器，依赖于内容仓库，对排版和交互进行了优化。\r\n\r\n2022/10/28 更新支持查看 Node.js 官网文档。主要是因为在写一个库的时候，频繁查文档看得都吐了，滚动滚到手抽筋，到底部了还没有 scroll-to-top，花点时间干脆直接内建本地浏览了。[预览图](docs/screenshot-nodejs-api.png)\r\n\r\n## TODO\r\n\r\n+ 内置搜索引擎。新建搜索窗口，使用 Google 等等的高级 `site:` 选项搜索 mdn，拦截 url 点击请求跳转应用内。\r\n+ Related Topics 宏优化。目前该功能使用 `{{SideBar}}` 宏定义在 `yari` 仓库中，考虑使用 `.ejs` 模板引擎提取数据。\r\n+ 版权文件\r\n+ caniuse 兼容性。内嵌 or 提取 bcd 仓库数据？待定\r\n\r\n## Customization\r\n\r\n```shell\r\nrcedit electron.exe --set-file-version \"0.0.1.0\"\r\nrcedit electron.exe\r\n    --set-icon favicon.ico\r\n    --set-version-string \"CompanyName\" \"litilexuezha\"\r\n    --set-version-string \"FileVersion\" \"\"\r\n    --set-version-string \"FileDescription\" \"MDN Docs Desktop\"\r\n    --set-version-string \"LegalCopyright\" \"MIT License, Copyright (c) litilexuezha\"\r\n    --set-version-string \"OriginalFilename\" \"MDN-Docs-Desktop.exe\"\r\n    --set-version-string \"ProductName\" \"MDN Docs Desktop\"\r\n    --set-version-string \"ProductVersion\" \"\"\r\nmv electron.exe MDN-Docs-Desktop.exe\r\n```\r\n\r\n### Linux\r\n\r\n1. Rename `electron` to `mdn-docs-desktop`\r\n2. Download `assets/mdn-web-doc.png`\r\n3. Add `mdn-docs-desktop.desktop`\r\n\r\nAssume your path is like this:\r\n\r\n```\r\n~/Downloads/electron\r\n├── resources\r\n│   └── app.asar\r\n├── ...\r\n├── mdn-docs-desktop\r\n├── mdn-web-docs.png\r\n```\r\n\r\nCreate a `.desktop` file in `~/.local/share/applications` or `/usr/share/applications`.\r\n\r\n```\r\n[Desktop Entry]\r\nVersion=1.0\r\nType=Application\r\nName=MDN Docs Desktop\r\nExec=/home/yourname/Downloads/electron/mdn-docs-desktop\r\nIcon=/home/yourname/Downloads/electron/mdn-web-docs.png\r\nMimeType=image/x-foo;\r\nActions=new-window\r\n\r\n[Desktop Action new-window]\r\nExec=/home/yourname/Downloads/electron/mdn-docs-desktop\r\nName=New Window\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitilexuezha%2Fmdn-docs-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flitilexuezha%2Fmdn-docs-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flitilexuezha%2Fmdn-docs-desktop/lists"}