/browser-diet

:fries: The definitive front-end performance guide

Primary LanguageCSS

How to lose weight (in the browser) Build Status

The definitive front-end performance guide.

image

Contributing

If you want to add new tips or edit the existing ones, just go to the src/documents folder. There you can find all of them in Markdown (.md) format. Remember to add references on each tip that you write at References wiki.

Instructions

How can I locally run the project?

  1. Install Git and NodeJS, if you don't have them already.

  2. Open your terminal and download DocPad through this command:

$ [sudo] npm install -g docpad@6.78.4
  1. Now clone it:
$ git clone git@github.com:<your-github-username>/browser-diet.git
  1. Then go to the project's folder:
$ cd browser-diet
  1. Install all dependencies:
$ npm install
  1. And finally run:
$ docpad run

Now you can see the website running at localhost:9778 :D

How can I run another language version?

Simply go to the docpad.coffee file and change the value of the currentLang variable.

Then you just need to run docpad run again.

Browser Support

We do care about it.

IE Chrome Firefox Opera Safari
IE 9+ ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Structure

This project uses DocPad, a static generator in NodeJS, and here's the basic structure:

.
|-- out/
|-- src/
|   |-- documents
|   |-- layouts
|   |-- partials
`-- package.json

out/

This is where the generated files are stored, once DocPad has been run. However, this directory is unnecessary for versioning, so it is ignored (.gitignore).

src/documents

Contains all tips in Markdown (.md) format, in addition to images, fonts, CSS and JS files.

src/layouts

Contains the default template.

src/partials

Contains reusable blocks of code.

package.json

Lists all NodeJS dependencies.

Team

BrowserDiet was made with love by these people and a bunch of awesome contributors.

Creator

Zeno Rocha | --- | --- | --- | --- | --- | --- | --- Zeno Rocha
Liferay, Inc. |

Design

Briza Bueno | --- | --- | --- | --- | --- | --- | --- Briza Bueno
Americanas |

Authors

Davidson Fellipe | Giovanni Keppelen | Jaydson Gomes --- | --- | --- | --- | --- | --- | --- Davidson Fellipe
Globo.com | Giovanni Keppelen
Planedia | Jaydson Gomes
Terra

Reviewers

Marcel Duran | Renato Mangini | Sérgio Lopes --- | --- | --- | --- | --- | --- | --- Marcel Duran
Twitter | Renato Mangini
Google | Sérgio Lopes
Caelum

Translations

Mike Taylor Emilio Álvarez Lukasz Jakub Fordlee Nicolas Carlo Tomas Dvorak Makoto Tateno
Mike Taylor
English		 Emilio Álvarez
Spanish		 Lukasz Jakub
Polish		 Fordlee
Chinese		 Nicolas Carlo
French		 Tomas Dvorak
Czech		 Makoto Tateno
Japanese

Credits

Fonts

Illustrations

License

Code is under MIT license and content is under Creative Commons BY-SA 3.0