diff --git a/.gitignore b/.gitignore index 5b71628a9..edf5fc964 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ *.sw[op] .DS_Store node_modules +_site diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..37f5eaa42 --- /dev/null +++ b/Gemfile @@ -0,0 +1,2 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..22afb2227 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,201 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.7) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.5.0) + public_suffix (~> 2.0, >= 2.0.2) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.12.2) + colorator (1.1.0) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.11.0) + multipart-post (>= 1.2, < 3) + ffi (1.9.17-x64-mingw32) + forwardable-extended (2.6.0) + gemoji (2.1.0) + github-pages (117) + activesupport (= 4.2.7) + github-pages-health-check (= 1.3.0) + jekyll (= 3.3.1) + jekyll-avatar (= 0.4.2) + jekyll-coffeescript (= 1.0.1) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.8.0) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.3.1) + jekyll-mentions (= 1.2.0) + jekyll-optional-front-matter (= 0.1.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.0.3) + jekyll-redirect-from (= 0.11.0) + jekyll-relative-links (= 0.2.1) + jekyll-sass-converter (= 1.5.0) + jekyll-seo-tag (= 2.1.0) + jekyll-sitemap (= 0.12.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.0.3) + jekyll-theme-cayman (= 0.0.3) + jekyll-theme-dinky (= 0.0.3) + jekyll-theme-hacker (= 0.0.3) + jekyll-theme-leap-day (= 0.0.3) + jekyll-theme-merlot (= 0.0.3) + jekyll-theme-midnight (= 0.0.3) + jekyll-theme-minimal (= 0.0.3) + jekyll-theme-modernist (= 0.0.3) + jekyll-theme-primer (= 0.1.7) + jekyll-theme-slate (= 0.0.3) + jekyll-theme-tactile (= 0.0.3) + jekyll-theme-time-machine (= 0.0.3) + jekyll-titles-from-headings (= 0.1.4) + jemoji (= 0.7.0) + kramdown (= 1.11.1) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 2.0.0) + nokogiri (= 1.6.8.1) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.3.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 2.0) + typhoeus (~> 0.7) + html-pipeline (2.5.0) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.7.0) + jekyll (3.3.1) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.8.0) + jekyll (~> 3.3) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.3.1) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.1.2) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.0.3) + jekyll (~> 3.0) + jekyll-redirect-from (0.11.0) + jekyll (>= 2.0) + jekyll-relative-links (0.2.1) + jekyll (~> 3.3) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) + jekyll-seo-tag (2.1.0) + jekyll (~> 3.3) + jekyll-sitemap (0.12.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.0.3) + jekyll (~> 3.3) + jekyll-theme-cayman (0.0.3) + jekyll (~> 3.3) + jekyll-theme-dinky (0.0.3) + jekyll (~> 3.3) + jekyll-theme-hacker (0.0.3) + jekyll (~> 3.3) + jekyll-theme-leap-day (0.0.3) + jekyll (~> 3.3) + jekyll-theme-merlot (0.0.3) + jekyll (~> 3.3) + jekyll-theme-midnight (0.0.3) + jekyll (~> 3.3) + jekyll-theme-minimal (0.0.3) + jekyll (~> 3.3) + jekyll-theme-modernist (0.0.3) + jekyll (~> 3.3) + jekyll-theme-primer (0.1.7) + jekyll (~> 3.3) + jekyll-theme-slate (0.0.3) + jekyll (~> 3.3) + jekyll-theme-tactile (0.0.3) + jekyll (~> 3.3) + jekyll-theme-time-machine (0.0.3) + jekyll (~> 3.3) + jekyll-titles-from-headings (0.1.4) + jekyll (~> 3.3) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.7.0) + activesupport (~> 4.0) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + json (1.8.6) + kramdown (1.11.1) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.1.0) + minima (2.0.0) + minitest (5.10.1) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.8.1-x64-mingw32) + mini_portile2 (~> 2.1.0) + octokit (4.6.2) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + public_suffix (2.0.5) + rb-fsevent (0.9.8) + rb-inotify (0.9.8) + ffi (>= 0.5.0) + rouge (1.11.1) + safe_yaml (1.0.4) + sass (3.4.23) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.7.3) + unicode-display_width (~> 1.1.1) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + unicode-display_width (1.1.3) + +PLATFORMS + x64-mingw32 + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.14.3 diff --git a/README.rst b/README.rst index 1f1dc83eb..6631f4bb6 100644 --- a/README.rst +++ b/README.rst @@ -52,6 +52,23 @@ A list of all previous specification drafts is also available. http://json-ld.org/spec/ +The Web Site +------------ + +Below are the basics for running this web site locally and/or contributing to +it. + +The site is hosted on GitHub Pages. A foundational setup guide can be found at +https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/ + +Essentially: + +* install Ruby +* install Jekyll +* install Bundler +* `bundle install` in this directory +* `bundle exec jekyll serve --watch` + .. _list of users: https://github.com/json-ld/json-ld.org/wiki/Users-of-JSON-LD .. _JSON-LD 1.0 - A JSON-based Serialization for Linked Data: http://www.w3.org/TR/json-ld/ .. _JSON-LD 1.0 Processing Algorithms and API: http://www.w3.org/TR/json-ld-api/ diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..daafb0844 --- /dev/null +++ b/_config.yml @@ -0,0 +1,20 @@ +# Based off GitHub defaults +# https://help.github.com/articles/configuring-jekyll/#defaults-you-can-change +# github: [metadata] +kramdown: + input: GFM + hard_wrap: false +gems: + - jekyll-paginate + +# GitHub sets these--and they cannot be changed there +# https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change +lsi: false +safe: true +#source: [your repo's top level directory] +incremental: false +highlighter: rouge +gist: + noscript: false +kramdown: + math_engine: mathjax diff --git a/_includes/deep_doc_list.html b/_includes/deep_doc_list.html new file mode 100644 index 000000000..094a5be00 --- /dev/null +++ b/_includes/deep_doc_list.html @@ -0,0 +1,20 @@ +{% assign dir = page.dir %} +{% assign paths = '' | split: '' %} + +{% for file in site.static_files reversed %} +{% if file.path contains dir and file.name == 'index.html' %} + {% if file.path contains include.find or file.path contains include.find_other %} + {% unless file.path contains 'latest' %} + {% assign path_array = file.path | split: '/' %} + {% assign date_path = '' | split: '' %} + {% assign date_path = date_path | push: path_array[4] %} + {% assign date_path = date_path | push: path_array %} + {% assign date_path = date_path | join: '|' %} + {% assign paths = paths | push: date_path %} + {% endunless %} + {% endif %} +{% endif %} +{% endfor %} + +{% assign paths = paths | sort | reverse %} +{% for path in paths %}{% assign split_path = path | split: '||' %}{% assign doc_path = split_path[1] | split: '|' | join: '/' %}{{ split_path[0] }}{% endfor %} diff --git a/_includes/doc_list.html b/_includes/doc_list.html new file mode 100644 index 000000000..1319af939 --- /dev/null +++ b/_includes/doc_list.html @@ -0,0 +1,6 @@ +{% assign dir = page.dir | append: include.subdir %} +{% for file in site.static_files reversed %} +{% if file.path contains dir %} +