Git Product home page Git Product logo

webfundamentals's Introduction

Web Fundamentals

Web Fundamentals is a technical documentation center for multi-device web development. Our goal is to build a resource for modern web developers that’s as curated and thorough as developer.android.com or iOS Dev Center.

Links: Live site | Planned content

Release status

The project was initiated in late March and soft launched to the public on April 30th. We're planning for a more polished 1.0 release in June.

Technology

This is a Jekyll build.

/src
  /appengine - the server to host the static content
  /site - the documentation
    /getting-started - the getting started articles
    /multi-device-layouts - responsive design guide
    /introduction-to-media - the guide to using media
    /optimizing-performance - the perf articles
    /using-touch - managing touch
    /showcase - the case-studies

/build is never checked in but generated by Jekyll.

Installing Dependencies

Mac

  1. Install XCode Command Line Tools
  2. Install RVM
    • curl -sSL https://get.rvm.io | bash
  3. Set RVM Default to 2.0.0
    • rvm install ruby-2.0.0-p451
    • rvm --default use 2.0.0
  4. Install Pygments
    • easy_install pygments
  5. Install RubyGems dependencies (Jekyll, Kramdown and Sass)
    • cd src/ && bundle install
  6. Install Node.js
  7. Install the Grunt CLI
    • npm install -g grunt-cli

Using project-level meta data

The table of contents is generated from src/site/_project.yaml

To parse the _project.yaml file, include {% injectdata content _project.yaml %} in the page. You then have access to the variables in the page object.

Generating Table of Contents

The table of contents is generated from src/site/_book.yaml

To parse the _book.yaml file, include {% injectdata content _book.yaml %} in the page and then iterate as follows:

 {% for section in page.content.toc %}
    SOME MARKUP
 {% endfor %}

Jekyll Special elements

  • Code import: {% highlight javascript %} {% include sample1.js %} {% endhighlight %}
  • {{ articles _category_}} a list of articles in divs, ordered by the "order" preamble.
  • {{ showcases _category_}} a list of showcases.

webfundamentals's People

Contributors

paulkinlan avatar petele avatar meggin avatar samdutton avatar ianbarber avatar igrigorik avatar maxh avatar trott avatar mnot avatar achalv avatar addyosmani avatar 0ssifrage avatar coliff avatar cvan avatar dunnkers avatar harshadsabne avatar ikkebr avatar xiongchiamiov avatar u01jmg3 avatar kgeis avatar mco-gh avatar mmocny avatar pborreli avatar paullewis avatar philhawksworth avatar robations avatar shanehudson avatar adnang avatar bengesoff avatar schettino72 avatar

Watchers

库国兵 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.