Skip to content

terrorizer1980/electronjs.org-new

 
 

Repository files navigation

electronjs.org-new

This repository contains the code for the new electronsjs.org website. It is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

If you want to use the contents from electron/electron run the following:

yarn prebuild
yarn start

If you want the website to pick your local documentation, run:

yarn prebuild ../relative/path/to/local/electron/repo
yarn start

For example, if you have the following structure:

└── projects
     ├─ electron
     ├─ electronjs.org-new
     ├─ ...

and assuming your prompt is in /projects/electronjs.org-new/ you will have to run:

yarn prebuild ../electron
yarn start

yarn start starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Repository content organization

This repository contains the code for 2 related things:

The content of this repository is organized as follows:

└─ root
    |
    ├─ .github/workflows → The definitions for the GitHub actions
    |
    |
    ├─ create-electron-documentation → Code for the npm package
    |        of the same name. Read the readme in the folder
    |        for more information.
    |
    ├─ scripts → The code for the package.json tasks and GitHub
    |        actions
    |
    ├─ spec → Tests for the scripts
    |
    ├─ src → Docusaurus code
    |
    ├─ static → Docusaurus static assets

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.6%
  • CSS 1.8%
  • Other 0.6%