Skip to content

Latest commit

 

History

History
208 lines (177 loc) · 17.6 KB

README.md

File metadata and controls

208 lines (177 loc) · 17.6 KB

All Contributors

Build Status Dependency Status MIT Licensed lepton

Lepton is a lean code snippet manager powered by GitHub Gist. Check out the latest release.

Features

  • Unlimited public/secret snippets
  • Unlimited tags
  • Language groups
  • Markdown/JupyterNotebook
  • GitHub Enterprise
  • GitHub token
  • Immersive mode
  • Customizable
  • Light/Dark theme
  • macOS/Win/Linux
  • Dashboard
  • Search
  • Proxy
  • Free

Screenshot

Light Theme Dark Theme
Screenshot Screenshot
Organize Markdown Jupyter Notebook
Screenshot Screenshot Screenshot
Search (⇧ + Space) Immersive Mode (⌘/Ctrl + i) Dashboard (⌘/Ctrl + d)
Screenshot Screenshot Screenshot

Shortcuts

Function Shortcut Note
New Snippet Cmd/Ctrl + N Create a snippet
Edit Snippet Cmd/Ctrl + E Edit a snippet
Delete Snippet Cmd/Ctrl + Del Delete selected snippet
Submit Cmd/Ctrl + S Submit the changes from the editor
Cancel Cmd/Ctrl + ESC Exit the editor without saving
Sync Cmd/Ctrl + R Sync with remote Gist server
Immersive Mode Cmd/Ctrl + I Toggle the Immersive mode
Dashboard Cmd/Ctrl + D Toggle the dashboard
About Page Cmd/Ctrl + , Toggle the About page
Search Shift + Space Toggle the search bar

Customization

Lepton's can be customized by <home_dir>/.leptonrc! You can find its exact path in the About page by Command/Ctrl + ,. Create the file if it does not exist.

  • Theme (light/dark)
  • Snippet
  • Editor
  • Logger
  • Proxy
  • Shortcuts
  • Enterprise
  • Notifications

Check out the configuration docs to explore different customization options.

Tech Stack

Based on

  1. Framework: Electron
  2. Bundler: Webpack, Babel, electron-builder
  3. Language: ES6, Sass
  4. Library: React, Redux, Redux Thunk, Redux Form
  5. Lint: ESLint

Installation

brew install --cask lepton
snap install lepton

Based on

Development

Install dependencies

$ git clone https://github.com/hackjutsu/Lepton.git
$ cd Lepton && yarn install
# inspect stale dependencies
$ yarn check-outdated

Client ID/Secret

Register your application, and put your client id and client secret in ./configs/account.js.

module.exports = {
  client_id: <your_client_id>,
  client_secret: <your_client_secret>
}

Run

$ yarn build && yarn start

Build Installer App

Read electron-builder docs and check out the code signing wiki before building the installer app.

Build apps for macOS.

$ yarn dist -m

Build apps for Windows.

$ yarn dist -w

Build apps for Linux.

Need a running Docker daemon to build a snap package.

$ yarn dist -l

Build apps for macOS, Windows and Linux.

$ yarn dist -wml

Build apps for the current OS with the current arch.

$ yarn dist

FAQ

--> Wiki FAQ

Contributors

CosmoX
CosmoX

💻 🎨 ⚠️ 🚧 📦 🤔
Jiaye Wu
Jiaye Wu

💻 🚧 🤔
Danila
Danila

💻 🎨 🚧
Meilin Zhan
Meilin Zhan

💻 🤔 🚧
lcgforever
lcgforever

💻
Yuer Lee
Yuer Lee

📖 📦
Su,Yen-Yun
Su,Yen-Yun

📖
Chen Tong
Chen Tong

💻 🤔 🚧
Jason Jiang
Jason Jiang

💻
Alan Pope
Alan Pope

📦
Tony Xu
Tony Xu

📦
Tegan Churchill
Tegan Churchill

💻
Angie Wang
Angie Wang

🎨
Batuhan Bayrakci
Batuhan Bayrakci

💻
Samuel Meuli
Samuel Meuli

💻
Alexandre Amado de Castro
Alexandre Amado de Castro

💻
Abner Soares Alves Junior
Abner Soares Alves Junior

💻
Sean
Sean

💻
Ole
Ole

💻
Gabriel Nicolas Avellaneda
Gabriel Nicolas Avellaneda

💻 📖
Dennis Ideler
Dennis Ideler

💻 🤔 📖
Anthony Attard
Anthony Attard

💻
ArLE
ArLE

💻
Pol Maresma
Pol Maresma

💻
PM Extra
PM Extra

💻
Zava
Zava

💻
Jason R Alexander
Jason R Alexander

💻
Sebastian Hojas
Sebastian Hojas

📖
董雨航
董雨航

💻
sxyazi
sxyazi

📦
Brian Zalewski
Brian Zalewski

📦

License

MIT © hackjutsu