material-branch staging: https://material-dot-web-central.appspot.com/web/
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.
To build and run this project you need to have Ruby, Node and NPM.
- Install XCode Command Line Tools
- Install node
- Install RVM
curl -sSL https://get.rvm.io | bash
- Set RVM Default to 2.2.0
rvm install ruby-2.2.0
rvm --default use 2.2.0
- Install Pygments
- Install bundler
gem install bundler
- Install RubyGems dependencies (Jekyll and Kramdown)
rvm . do bundle install
- Install the Gulp CLI
npm install -g gulp
- Install npm dependencies
- Get the App Engine SDK and unzip into the google_appengine folder inside the project root. Add it to your path accordingly (in bash,
Running the site
To run the site:
Any changes to files will result in the appropriate tasks be running in gulp.
Faster Jekyll Builds
To make the build faster you can define a language and/or section of the site be built.
If you want to build a single language then run this:
gulp --lang en
If you want to build a specific section then run this:
gulp --section shows
These can be combined like so:
gulp --lang en --section shows
Learning More About Jekyll and Liquid Used
We have a styleguide which you can access at http://localhost:7331/web/styleguide/ that should get you up and running with a lot of the custom and useful info.
You need the python Google API client
pip install --upgrade google-api-python-client
Content plan for Web Fundamentals is tracked through GitHub Issues and our Site Structure + Content Inventory doc
The project was soft launched in late April with a formal v1 launch in June 2014. We've now moved to a six-week rolling release cycle.
This is a Jekyll build.
The site is generated in
/build, which is never checked in.
Web Fundamentals is an open source project and we welcome your contributions! Before submitting a pull request, please review CONTRIBUTING.md and make sure that there is an issue filed describing the fix or new content. If you don't complete these steps, we won't be able to accept your pull request, sorry.