Move documentation from gh-pages branch to 'docs' folder

To prepare the migration to 3.0, we need to change the location where the documentation is generated from. Having a gh-pages branch makes it hard to synchronize the code and the docs. Having a "docs" folder in the repo itself simplifies this.
2019-05-22 09:45:45 +02:00
1 parent a420e3fffa
commit c62177f0e4
@@ -0,0 +1,9 @@
+{% if site.algolia.enabled %}
+<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+<script type="text/javascript"> docsearch({
+    apiKey: '{{ site.algolia.apiKey }}',
+    indexName: '{{ site.algolia.indexName }}',
+    inputSelector: '#algolia-doc-search'
+});
+</script>
+{% endif %}
@@ -0,0 +1,12 @@
+{% if site.google_analytics %}
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+
+</script>
+{% endif %}
@@ -0,0 +1,9 @@
+<div class="site-banner">
+    <div class="wrapper vertical-align-middle">
+        <p class="tag-line">
+            Read and write spreadsheets
+            <br />
+            <strong>quickly</strong> and <strong>at scale</strong>
+        </p>
+    </div>
+</div>
@@ -0,0 +1,9 @@
+<!-- http://ricostacruz.com/til/relative-paths-in-jekyll.html -->
+<!-- _includes/base.html -->
+
+{% assign base = '' %}
+{% assign depth = page.url | split: '/' | size | minus: 1 %}
+{% if    depth == 1 %}{% assign base = '.' %}
+{% elsif depth == 2 %}{% assign base = '..' %}
+{% elsif depth == 3 %}{% assign base = '../..' %}
+{% elsif depth == 4 %}{% assign base = '../../..' %}{% endif %}
@@ -0,0 +1,25 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col footer-col-1">
+        <ul class="contact-list">
+          <li>Need to contact us?<br><a href="https://gitter.im/box/spout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/box/spout.svg" alt="Join the chat at https://gitter.im/box/spout" /></a></li>
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-2">
+        <ul class="social-media-list">
+          <li><a href="https://github.com/box/spout/issues"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">GitHub Issues</span></a></li>
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-3">
+        <p>{{ site.title }} - {{ site.description }}</p>
+      </div>
+    </div>
+
+  </div>
+
+</footer>
@@ -0,0 +1,17 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+  <link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.github.url }}">
+  {% if site.algolia.enabled %}
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
+  {% endif %}
+
+  {% if jekyll.environment == 'production' %}
+  {% include analytics.html %}
+  {% endif %}
+</head>
@@ -0,0 +1,30 @@
+<header class="site-header">
+
+  <div class="wrapper">
+    <a class="site-title" href="{{ site.github.url }}/">{{ site.title }}</a>
+
+    <nav class="site-nav">
+      <a href="#" class="menu-icon">
+        <svg viewBox="0 0 18 15">
+          <path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
+          <path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
+          <path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
+        </svg>
+      </a>
+      <div class="trigger">
+        <a class="page-link" href="{{ site.github.url }}/getting-started/">Getting Started</a>
+        <a class="page-link" href="{{ site.github.url }}/docs/">Documentation</a>
+        <a class="page-link" href="{{ site.github.url }}/guides/">Guides</a>
+        <a class="page-link" href="{{ site.github.url }}/faq/">FAQ</a>
+        <a class="page-link" href="https://github.com/box/spout">GitHub</a>
+        {% if site.algolia.enabled %}
+        <span class="site-search">
+          <input type="text" id="algolia-doc-search">
+        </span>
+        {% endif %}
+      </div>
+    </nav>
+
+  </div>
+
+</header>
@@ -0,0 +1 @@
+<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">{{ include.username }}</span></a>
@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16"><path fill="#828282" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/></svg>
@@ -0,0 +1,11 @@
+{% assign sectionClass = "section-even centered" %}
+{% assign sectionTitle = "Fast and Scalable" %}
+{% assign sectionIcons = "icon-lightning-bolt.png" %}
+
+{% capture sectionContent %}
+    Reading a small CSV file? No problem!<br>
+    Reading a huge XLSX file? No extra code needed!<br>
+    Writing an ODS file with millions of rows? {{ site.spout_html }} can do it in no time!
+{% endcapture %}
+
+{% include section.html %}
@@ -0,0 +1,14 @@
+{% assign sectionClass = "section-odd centered" %}
+{% assign sectionTitle = "Supported Spreadsheet Types" %}
+{% assign sectionIcons = "icon-xlsx.png~~icon-ods.png~~icon-csv.png" %}
+
+{% assign emS = '<span class="light-em">' %}
+{% assign emE = '</span>' %}
+
+{% capture sectionContent %}
+    {{ site.spout_html }} supports 3 types of spreadsheets: {{emS}}XLSX{{emE}}, {{emS}}ODS{{emE}} and {{emS}}CSV{{emE}}.<br>
+    {{ site.spout_html }} provides a simple and unified API to read or create these different types of spreadsheets.
+    Switching from one type to another is ridiculously easy!
+{% endcapture %}
+
+{% include section.html %}
@@ -0,0 +1,20 @@
+{% assign sectionClass = "section-odd last-section" %}
+{% capture sectionTitle %}Why use {{ site.spout_html }}?{% endcapture %}
+{% assign sectionIcons = "" %}
+
+{% assign emS = '<span class="light-em">' %}
+{% assign emE = '</span>' %}
+
+{% capture sectionContent %}
+    <ul class="feature-list">
+        <li class="feature-check">{{ site.spout_html }} is capable of processing files of {{emS}}any size{{emE}}.</li>
+        <li class="feature-check">{{ site.spout_html }} needs {{emS}}only 3MB{{emE}} of memory to process any file.</li>
+        <li class="feature-check">{{ site.spout_html }}'s streaming mechanism makes it {{emS}}incredibly fast{{emE}}.</li>
+        <li class="feature-check">{{ site.spout_html }}'s API is {{emS}}developer-friendly{{emE}}.</li>
+    </ul><br>
+    <div class="btn-wrapper">
+        <a href="{{ site.github.url }}/getting-started/" class="page-link"><button class="btn">Get started</button></a>
+    </div>
+{% endcapture %}
+
+{% include section.html %}
@@ -0,0 +1,17 @@
+
+<div class="section {{ sectionClass }} vertical-align-middle">
+  <div class="wrapper">
+    <div class="description mbl">
+      <h2 class="section-title">{{ sectionTitle }}</h2>
+      {{ sectionContent }}
+    </div>
+    {% if sectionIcons %}
+      {% assign sectionIconsAsArray = sectionIcons | split:'~~' %}
+      <div class="icons">
+      {% for icon in sectionIconsAsArray %}
+        <img src="{{ site.github.url }}/images/{{ icon }}"/>
+      {% endfor %}
+      </div>
+    {% endif %}
+  </div>
+</div>
				`@@ -0,0 +1 @@`
				`<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">{{ include.username }}</span></a>`
				`@@ -0,0 +1 @@`
				<svg viewBox="0 0 16 16"><path fill="#828282" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/></svg>