How to lose weight (in the browser)

The definitive front-end performance guide.

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?

Install Git and NodeJS, if you don't have them already.
Open your terminal and download DocPad through this command:

sudo npm install -fg docpad

Now clone it:

git clone git@github.com:<your-github-username>/browser-diet.git

Then go to the project's folder:

cd browser-diet

Install all dependencies:

docpad install

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.

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

Zeno Rocha (Liferay)

Design

Briza Bueno (Americanas.com)

Credits

DocPad by Benjamin Lupton
Highlight.js by Ivan Sagalaev

Fonts

Pacifico by Vernon Adams
Open Sans by Steve Matteson
Horseshoes by Lauren Ashpole

Illustrations

The 56 Geeks Project by Scott Johnson

License

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

rabipelais / browser-diet