https://github.com/jlord/essential-electron
Concise plain-speak about Electron
https://github.com/jlord/essential-electron
Last synced: 7 months ago
JSON representation
Concise plain-speak about Electron
- Host: GitHub
- URL: https://github.com/jlord/essential-electron
- Owner: jlord
- License: mit
- Created: 2016-08-17T03:12:16.000Z (over 9 years ago)
- Default Branch: gh-pages
- Last Pushed: 2022-03-21T20:55:00.000Z (almost 4 years ago)
- Last Synced: 2025-05-04T20:41:18.454Z (8 months ago)
- Language: HTML
- Homepage: jlord.us/essential-electron
- Size: 807 KB
- Stars: 322
- Watchers: 14
- Forks: 40
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Essential Electron
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.
---
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:
Here's a [blog post](http://jlord.us/blog/essential-electron.html) with a bit more info.
### Build it
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`.
The stylesheet is `style.css` and it uses system fonts unless you have Source Sans Pro installed locally.
You'll need [Node.js](https://nodejs.org) to build this site:
```bash
# Clone repository
git clone https://github.com/jlord/essential-electron.git
# Go into repository clone
cd essential-electron
# Install dependencies
npm install
# Rebuild if changes have been made to:
# index.md, footer.html, header.html
npm start
# Open the page in your browser
open index.html
```