Code Monkey home page Code Monkey logo

html-build's Introduction

HTML Build Tools

This repository contains the tools and instructions necessary for building the HTML Standard from its source.

Prerequisites

Before building, make sure you have the following commands installed on your system.

  • curl, egrep, git, grep, perl, python, svn, unzip

You'll also need to have the Perl XML::Parser module installed on your system. It's not a "core" Perl module, so you may have to install it by doing one of the following to either get it using the perl cpan install command, or by getting the version packaged for your OS; for example;

  • cpan install XML::Parser
  • apt-get install libxml-parser-perl (Ubuntu)

Build

Building your own copy of the HTML Standard from its source requires just two simple steps:

  1. Clone this (html-build) repo:
    git clone https://github.com/whatwg/html-build.git && cd html-build
  1. Run the build.sh script from inside your html-build working directory, like this:
    ./build.sh

Output

After you complete the build steps above, the build will run and generate the single-page version of the spec, the multipage version, and more. If all goes well, you should very soon have all the following in your output/ directory:

  • .htaccess
  • 404.html
  • entities.json
  • fonts/*
  • images/*
  • index
  • link-fixup.js
  • multipage/*

And then you're also ready to edit the html/source file—and after you make your changes, you can run the build.sh script again to see the new output.

Options

Your clone doesn't need the HTML standard's complete revision history just for you to build the spec and contribute patches. So, by default we don't start you out with a clone of the history. That makes your first build finish much faster. And if later you decide you do want to clone the complete history, you can still get it, by doing this:

   cd ./html && git fetch --unshallow

That said, if you really do want to start out with the complete history of the repo, then run the build script for the first time like this:

   HTML_GIT_CLONE_OPTIONS="" ./build.sh

That will clone the complete history for you. But be warned: It'll make your first build take dramatically longer to finish!

html-build's People

Contributors

sideshowbarker avatar annevk avatar domenic avatar cvrebert avatar hober avatar hixie avatar zcorpan avatar wakaba avatar

Watchers

 avatar James Cloos 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.