How electron/website works
Project type and purpose
• This is a static‐site project for the Electron website (electronjs.org) built with Docusaurus (a React-based static site generator).
• It also includes an npm package (“create-electron-documentation”) for automating doc scaffolding, and integrates with Crowdin (for translations), Algolia DocSearch, and GitHub Actions for CI/CD.
File structure
• Top‐level content folders:
• blog/ ← Markdown blog posts
• docs/ ← Mirrored Electron API & tutorials
• create-electron-documentation/ ← Standalone CLI package
• i18n/ ← Localization source files
• static/ ← Static assets (images, logos, etc.)
• Core build code:
• src/ ← Docusaurus custom React components, pages, plugins, transformers
• scripts/ ← Pre-build, i18n, API‐history, and other data‐prep scripts
• .github/ ← GitHub Actions workflows
• Config & metadata:
• docusaurus.config.ts, sidebars.js, package.json, tsconfig.json, .eslintrc.js, .prettierrc
README insights
• Built with Node.js (v22), Yarn, Docusaurus.
• Uses a “pre-build” step to pull in Electron repo docs.
• Crowdin manages translations; GitHub Actions automate doc updates, builds, and deploys.
• Algolia DocSearch provides search indexing.