Skip to content

added the bookmarklet section #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryanaltvater wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added the bookmarklet section #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,39 @@ This project adds a box and the class names around elements for easier debugging

## How to use it

### Bookmarklet

A little piece of JavaScript that can be saved as a bookmark in your browser, and then clicked to instantly enable/disable classbxr.

##### 1. Go to the [CodePen](http://codepen.io/ryanaltvater/pen/eWBKNG)

##### 2. Drag the button to your bookmarks bar

##### 3. Enjoy!

### Installation

It's easy, just load classbxr CDN on your HTML `<head>` and add the `.classbxr` on your `<body>` or any other element.

### 1. Load classbxr CDN
##### 1. Load classbxr CDN

```
<!DOCTYPE html>
<html>
<head>
...
<link rel="stylesheet" href="https://cdn.rawgit.com/srambach/classbxr/5456df40/css/classbxr.css">
<link rel="stylesheet" href="https://cdn.rawgit.com/srambach/classbxr/1767f73/css/classbxr.css">
</head>
...
```

### 2. Add classbxr class to the body
##### 2. Add classbxr class to the body

```
<body class="classbxr">
```

### 3. Enjoy!
##### 3. Enjoy!

## Contribute to classbxr

Expand All @@ -34,10 +46,10 @@ You can help improve classbxr by reporting an issue or sending a PR.
To build the project locally:

1. Fork and clone this repo.
1. If you don't have [nodejs](https://nodejs.org/en/) installed, go ahead and install it.
1. Once inside your folder run `npm install`
1. Now run `gulp`
2. If you don't have [nodejs](https://nodejs.org/en/) installed, go ahead and install it.
3. Once inside your folder run `npm install`
4. Now run `gulp`

A browser window will open with the test page on [http://localhost:3000/](http://localhost:3000/).

Edit the `classbxr.scss` and never the css directly.
Edit the `classbxr.scss` and never the css directly.