Git Product home page Git Product logo

browser-diet's Introduction

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 [email protected]:<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

browser-diet's People

Contributors

zenorocha avatar davidsonfellipe avatar keppelen avatar sergiolopes avatar marcelduran avatar emilio avatar irae avatar karbassi avatar mkxml avatar munter avatar mathiasbynens avatar tenzer avatar jaapie avatar benkeen avatar aishwar avatar avinash2 avatar caiogondim avatar charlietran avatar dmethvin avatar fizerkhan avatar heldr avatar jakearchibald avatar jorgemartind avatar lucascmelo avatar pborreli avatar mreq avatar bengie avatar

Watchers

Fred avatar  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.