Generating HTML views from GitHub (and Bikeshed) files

Hi all,

Here is how to view our GitHub files as they would appear in the spec:

#1. Find your GitHub identifier

Every commit on GitHub, including pull request, has a unique identifier 
in the system. You can find each from the "History" button just above 
the code. Here is the URI for the latest commit and for a pull request:

- 
https://github.com/w3c/wcag-act/blob/f9feaa88ac68b4448be3379deefb8211149f4d0c/act-framework.bs
- 
https://github.com/cpandhi/wcag-act/blob/b8ef4d8b3e02e871fc21c42cce8e30fe0b23547d/act-framework.bs


#2. Generate the RawGit content

"RawGit serves raw files directly from GitHub with proper Content-Type 
headers" - in our case the .bs (Bikeshed) files will be served as plain 
text. Here is the generated raw Bikeshed content for the above commits:

- 
https://rawgit.com/w3c/wcag-act/f9feaa88ac68b4448be3379deefb8211149f4d0c/act-framework.bs
- 
https://rawgit.com/cpandhi/wcag-act/b8ef4d8b3e02e871fc21c42cce8e30fe0b23547d/act-framework.bs


#3. Apply the Bikeshed styling

Now that you have the raw Bikeshed content, you can run that through the 
Bikeshed API to convert it to HTML and apply the W3C spec styling. Here 
are the two commits from above, converted into HTML for viewing:

- 
https://api.csswg.org/bikeshed/?url=https://rawgit.com/w3c/wcag-act/f9feaa88ac68b4448be3379deefb8211149f4d0c/act-framework.bs
- 
https://api.csswg.org/bikeshed/?url=https://rawgit.com/cpandhi/wcag-act/b8ef4d8b3e02e871fc21c42cce8e30fe0b23547d/act-framework.bs


#4. (optional) compare diffs

The HTMLdiff service compares two HTML files and marks up the changes 
between them (you may know this functionality from wikipedia etc). For 
example, here you can see the difference between the above two commits:

- 
http://services.w3.org/htmldiff?doc1=https%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Frawgit.com%2Fcpandhi%2Fwcag-act%2Fb8ef4d8b3e02e871fc21c42cce8e30fe0b23547d%2Fact-framework.bs&doc2=https%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Frawgit.com%2Fw3c%2Fwcag-act%2Ff9feaa88ac68b4448be3379deefb8211149f4d0c%2Fact-framework.bs


Happy GitHub'ing, RawGit'ing, Bikeshed'ing, and HTMLdiff'ing! :)

Best,
   Shadi

-- 
Shadi Abou-Zahra - http://www.w3.org/People/shadi/
W3C Web Accessibility Initiative (WAI)

Received on Tuesday, 20 December 2016 08:47:55 UTC