/browser-diet

The definitive front-end performance guide

Primary LanguageCoffeeScript

Leia em PortuguêsLeer en Español


How to lose weight (in the browser)

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 -fg docpad
  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:
docpad 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.

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).

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

Contains the default template.

Contains reusable blocks of code.

Lists all NodeJS dependencies.

Team

Design

Authors

Reviewers

Translations

Credits

Fonts

Illustrations

License

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