GithubHelp home page GithubHelp logo

surfingkeys-conf's Introduction

surfingkeys-conf

Configuration file for surfingkeys browser extension using esbuild

Why esbuild?

  • Surfingkeys doesn't support using es module for configuration file therefore we have to use commonjs module. But I want to use es module.
  • Esbuild is very fast.
  • I may use typescript in future.

Requirements

nodejs

Installation

Cloning repository

If you have git installed in your system, copy the following command in your terminal and run it.

git clone https://github.com/isaif/surfingkeys-conf.git

Installing dependencies

After cloning the repository run the following to install dependencies npm install or yarn

Generate Configuration file

We need to generate the config.js file which will be used by surfingkeys as settings file. Run the following command:

npm run build or yarn build.

This config.js will be generated inside the dist directory located at the root of the repository.

If the dist directory doesn't exist before running npm run build or yarn build then it will be created automatically.

Adding config file location in surfingkeys settings

To use this config file you need to tell surfingkeys where the file is located. You can do so in the settings page of surfingkeys which can be opened using ;e command in the browser or click on surfingkeys icon and select the settings option. Then enable Advanced mode and add the location of file in load settings from a file input.

You can add the path to config.js in surfingkeys directly or create a soft link in ~/.config/surfingkeys/config.js and add this path.

surfingkeys-conf's People

Contributors

isaif avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.