diff --git a/.gitignore b/.gitignore index c6873c31..e0689150 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# Dependency directories +Examples/ +node_modules/ +_site/ node_modules/ npm-debug.log package-lock.json diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..f46af413 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins + + diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 00000000..d6e38448 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,125 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.9) + i18n (~> 0.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (0.1) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) + ffi (1.9.18) + gemoji (2.1.0) + github-pages (80) + github-pages-health-check (= 1.1.0) + jekyll (= 3.1.6) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.5.1) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 1.11.1) + jekyll-mentions (= 1.1.2) + jekyll-paginate (= 1.1.0) + jekyll-redirect-from (= 0.10.0) + jekyll-sass-converter (= 1.3.0) + jekyll-seo-tag (= 1.4.0) + jekyll-sitemap (= 0.10.0) + jemoji (= 0.6.2) + kramdown (= 1.10.0) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + rouge (= 1.10.1) + terminal-table (~> 1.4) + github-pages-health-check (1.1.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 1.4) + typhoeus (~> 0.7) + html-pipeline (2.4.1) + activesupport (>= 2, < 5) + nokogiri (>= 1.4) + i18n (0.8.6) + jekyll (3.1.6) + colorator (~> 0.1) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-feed (0.5.1) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (1.11.1) + octokit (~> 4.0) + jekyll-mentions (1.1.2) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-redirect-from (0.10.0) + jekyll (>= 2.0) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-seo-tag (1.4.0) + jekyll (~> 3.0) + jekyll-sitemap (0.10.0) + jekyll-watch (1.4.0) + listen (~> 3.0, < 3.1) + jemoji (0.6.2) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + kramdown (1.10.0) + 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.0.0) + minitest (5.10.3) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.7.2) + mini_portile2 (~> 2.0.0.rc2) + octokit (4.3.0) + sawyer (~> 0.7.0, >= 0.5.3) + public_suffix (1.5.3) + rb-fsevent (0.10.2) + rb-inotify (0.9.10) + ffi (>= 0.5.0, < 2) + rouge (1.10.1) + safe_yaml (1.0.4) + sass (3.4.22) + sawyer (0.7.0) + addressable (>= 2.3.5, < 2.5) + faraday (~> 0.8, < 0.10) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.3) + thread_safe (~> 0.1) + unicode-display_width (1.3.0) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.12.5 diff --git a/README.md b/README.md index 6e6372ba..f472bf0f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ![Image of Flex the T-Rex](./assets/flex.png) +## Docs and Example Code +This repository contains a [wiki](https://github.com/tableau/ProjectFrelard/wiki) which contains developer documentation. You are encouraged to use it and also contribute. ## Setup and Running Samples diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..704cff97 --- /dev/null +++ b/_config.yml @@ -0,0 +1,30 @@ +# Site settings +title: Project Frelard +email: git@tableau.com +description: Create add-ins to extend the functionality of Tableau. +repository: d45/tableau.github.io +baseurl: "/extensions-api" +# permalink: pretty + +defaults: + - + scope: + path: "" # Apply to all files + type: pages + values: + layout: "default" + permalink: /:path/:basename:output_ext + + +# Build settings +markdown: kramdown +highlighter: rouge +github: [metadata] + +kramdown: + toc_levels: 1..3 + +# Exclude +exclude: ['node_modules', 'Examples'] + + diff --git a/_includes/analytics.html b/_includes/analytics.html new file mode 100644 index 00000000..0cdbad25 --- /dev/null +++ b/_includes/analytics.html @@ -0,0 +1,7 @@ + + + diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html new file mode 100644 index 00000000..72e0b49c --- /dev/null +++ b/_includes/docs_menu.html @@ -0,0 +1,46 @@ +
+ {% include search_form.html %} + +
diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 00000000..5b2182fa --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,8 @@ + + diff --git a/_includes/head.html b/_includes/head.html new file mode 100644 index 00000000..0160982e --- /dev/null +++ b/_includes/head.html @@ -0,0 +1,18 @@ + + + + + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} + + + + + + + + + + + + +{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %} diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 00000000..8566222a --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,31 @@ +
+
+ +
+
diff --git a/_includes/icon-github.svg b/_includes/icon-github.svg new file mode 100644 index 00000000..4422c4f5 --- /dev/null +++ b/_includes/icon-github.svg @@ -0,0 +1 @@ + diff --git a/_includes/search_form.html b/_includes/search_form.html new file mode 100644 index 00000000..41bb3425 --- /dev/null +++ b/_includes/search_form.html @@ -0,0 +1,7 @@ +
+ +
+ diff --git a/_layouts/api-ref.html b/_layouts/api-ref.html new file mode 100644 index 00000000..99f06085 --- /dev/null +++ b/_layouts/api-ref.html @@ -0,0 +1,20 @@ +--- +layout: api-ref +--- + + + + + {% include head.html %} + + + + +
+ {% include header.html %} + {{ content }} + +
+ + + diff --git a/_layouts/community.html b/_layouts/community.html new file mode 100644 index 00000000..ca12140c --- /dev/null +++ b/_layouts/community.html @@ -0,0 +1,30 @@ +--- +layout: community +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} +
+

{{ page.title }}

+ {{ content }} +
+
+
+ +
+
+ + + + {% include footer.html %} +
+ + + diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 00000000..38ee020b --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,34 @@ + + + + + {% include head.html %} + + + +
+ {% include header.html %} + + {% include footer.html %} +
+ + + diff --git a/_layouts/docs.html b/_layouts/docs.html new file mode 100644 index 00000000..c72f3fb3 --- /dev/null +++ b/_layouts/docs.html @@ -0,0 +1,31 @@ +--- +layout: docs +--- + + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

{{ page.title }}

+
+ Edit this page +   + Submit an issue +
+
+ {{ content }} + {% include footer.html %} +
+
+ + + diff --git a/_layouts/home.md b/_layouts/home.md new file mode 100644 index 00000000..c2cf32fc --- /dev/null +++ b/_layouts/home.md @@ -0,0 +1,19 @@ +--- +layout: home +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {{ content }} + {% include footer.html %} +
+ + + diff --git a/_layouts/news.html b/_layouts/news.html new file mode 100644 index 00000000..8bed88e3 --- /dev/null +++ b/_layouts/news.html @@ -0,0 +1,37 @@ +--- +layout: news +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} + + {% include footer.html %} +
+ + + diff --git a/_layouts/search.html b/_layouts/search.html new file mode 100644 index 00000000..2c76e6b0 --- /dev/null +++ b/_layouts/search.html @@ -0,0 +1,43 @@ +--- +layout: search +--- + + + + + + {% include head.html %} + + + + + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

+
+
+

Loading search results...

+
+ + {% include footer.html %} +
+
+ + diff --git a/assets/TcNTYA9566.gif b/assets/TcNTYA9566.gif new file mode 100644 index 00000000..3fca1cad Binary files /dev/null and b/assets/TcNTYA9566.gif differ diff --git a/assets/UsWdJEnOiR.gif b/assets/UsWdJEnOiR.gif new file mode 100644 index 00000000..5cc8b7fb Binary files /dev/null and b/assets/UsWdJEnOiR.gif differ diff --git a/assets/community.jpg b/assets/community.jpg new file mode 100644 index 00000000..5f5b043c Binary files /dev/null and b/assets/community.jpg differ diff --git a/assets/css/api_ref.css b/assets/css/api_ref.css new file mode 100644 index 00000000..62da9351 --- /dev/null +++ b/assets/css/api_ref.css @@ -0,0 +1,709 @@ +