├── .gitignore
├── LICENSE.md
├── README.md
├── favicon.png
├── footer.html
├── header.html
├── imgs
├── app-files.png
├── components.png
├── ipc.png
├── like-this.png
├── main.png
└── renderer.png
├── index-jp.html
├── index-jp.md
├── index.html
├── index.js
├── index.md
├── package.json
└── style.css
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2016 Jessica Lord
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # Essential Electron
4 |
5 | This is a informational website about Electron, answering essential Electron concepts in plain-speak, a few diagrams and links to resources for diving in deeper.
6 |
7 | ---
8 |
9 | This was an idea I had about a different type of documentation—or something—where text was kept short, jargon was expanded upon, concepts were defined and links provided for more in-depth explanations. I built this out because I couldn't get the idea out of my head without trying to see it through, so here it is! There is more I'll likely keep tweaking. Hopefully some will find it useful :smile:
10 |
11 | Here's a [blog post](http://jlord.us/blog/essential-electron.html) with a bit more info.
12 |
13 | ### Build it
14 |
15 | The site is built from one markdown file `index.md` with one bit of inline HTML for creating the styles on the vocabulary words. The markdown is parsed and turned into HTML, sandwiched between `header.html` and `footer.html` through a tiny Node script in `index.js`.
16 |
17 | The stylesheet is `style.css` and it uses system fonts unless you have Source Sans Pro installed locally.
18 |
19 | You'll need [Node.js](https://nodejs.org) to build this site:
20 |
21 | ```bash
22 | # Clone repository
23 | git clone https://github.com/jlord/essential-electron.git
24 | # Go into repository clone
25 | cd essential-electron
26 | # Install dependencies
27 | npm install
28 | # Rebuild if changes have been made to:
29 | # index.md, footer.html, header.html
30 | npm start
31 | # Open the page in your browser
32 | open index.html
33 | ```
34 |
--------------------------------------------------------------------------------
/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jlord/essential-electron/08431f0feedf8bad31a050eea43580abb4d4794e/favicon.png
--------------------------------------------------------------------------------
/footer.html:
--------------------------------------------------------------------------------
1 |
4 |
5 |
15 |
16 |