Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Convert docs pages with tables to textile format #843

Closed
wants to merge 4 commits into
from
@@ -1,95 +0,0 @@
----
-layout: docs
-title: Directory structure
-prev_section: usage
-next_section: configuration
----
-
-Jekyll at its core is a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed on the layout and more. This is all done through strictly editing files, and the web interface is the final product.
-
-A basic Jekyll site usually looks something like this:
-
-{% highlight bash %}
-.
-├── _config.yml
-├── _includes
-| ├── footer.html
-| └── header.html
-├── _layouts
-| ├── default.html
-| └── post.html
-├── _posts
-| ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
-| └── 2009-04-26-barcamp-boston-4-roundup.textile
-├── _site
-└── index.html
-{% endhighlight %}
-
-An overview of what each of these does:
-
-<table>
- <thead>
- <tr>
- <th>File / Directory</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <p><code>_config.yml</code></p>
- </td>
- <td>
- <p>Stores <a href="../configuration">configuration</a> data. A majority of these options can be specified from the command line executable but it’s easier to throw them in here so you don’t have to remember them.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><code>_includes</code></p>
- </td>
- <td>
- <p>These are the partials that can be mixed and matched by your _layouts and _posts to facilitate reuse. The liquid tag <code>{{ "{% include file.ext " }}%}</code> can be used to include the partial in <code>_includes/file.ext</code>.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><code>_layouts</code></p>
- </td>
- <td>
- <p>These are the templates which posts are inserted into. Layouts are chosen on a post-by-post basis in the <a href="../frontmatter">YAML front matter</a>, which is described in the next section. The liquid tag <code>{{ "{{ content " }}}}</code> is used to inject data onto the page.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><code>_posts</code></p>
- </td>
- <td>
- <p>Your dynamic content, so to speak. The format of these files is important, as named as <code>YEAR-MONTH-DAY-title.MARKUP</code>. The <a href="../permalinks">permalinks</a> can be adjusted very flexibly for each post, but the date and markup language are determined solely by the file name.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><code>_site</code></p>
- </td>
- <td>
- <p>This is where the generated site will be placed once Jekyll is done transforming it. It's probably a good idea to add this to your <code>.gitignore</code> file.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p><code>index.html</code> and other HTML, Markdown, Textile files</p>
- </td>
- <td>
- <p>Provided that the file has a <a href="../frontmatter">YAML Front Matter</a> section, it will be transformed by Jekyll. The same will happen for any <code>.html</code>, <code>.markdown</code>, <code>.md</code>, or <code>.textile</code> file in your site's root directory or directories not listed above.</p>
- </td>
- </tr>
- <tr>
- <td>
- <p>Other Files/Folders</p>
- </td>
- <td>
- <p>Every other directory and file except for those listed above—such as <code>css</code> and <code>images</code> folders, <code>favicon.ico</code> files, and so forth—will be transferred over verbatim to the generated site. There's plenty of <a href="../sites">sites already using Jekyll</a> if you're curious as to how they're laid out.</p>
- </td>
- </tr>
- </tbody>
-</table>
@@ -0,0 +1,37 @@
+---
+layout: docs
+title: Directory structure
+prev_section: usage
+next_section: configuration
+---
+
+Jekyll at its core is a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed on the layout and more. This is all done through strictly editing files, and the web interface is the final product.
+
+A basic Jekyll site usually looks something like this:
+
+{% highlight bash %}
+.
+├── _config.yml
+├── _includes
+| ├── footer.html
+| └── header.html
+├── _layouts
+| ├── default.html
+| └── post.html
+├── _posts
+| ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
+| └── 2009-04-26-barcamp-boston-4-roundup.textile
+├── _site
+└── index.html
+{% endhighlight %}
+
+An overview of what each of these does:
+
+(thead). |_. File / Directory |_. Description |
+| @_config.yml@ | Stores "configuration":../configuration data. A majority of these options can be specified from the command line executable but it’s easier to throw them in here so you don’t have to remember them. |
+| @_includes@ | These are the partials that can be mixed and matched by your @_layouts@ and @_posts@ to facilitate reuse. The liquid tag @{{ "{% include file.ext " }}%}@ can be used to include the partial in @_includes/file.ext@. |
+| @_layouts@ | These are the templates which posts are inserted into. Layouts are chosen on a post-by-post basis in the "YAML front matter":../frontmatter, which is described in the next section. The liquid tag @{{ "{{ content " }}}}@ is used to inject data onto the page. |
+| @_posts@ | Your dynamic content, so to speak. The format of these files is important, as named as @YEAR-MONTH-DAY-title.MARKUP@. The "permalinks":../permalinks can be adjusted very flexibly for each post, but the date and markup language are determined solely by the file name. |
+| @_site@ | This is where the generated site will be placed once Jekyll is done transforming it. It's probably a good idea to add this to your @.gitignore@ file. |
+| @index.html@ and other HTML, Markdown, Textile files | Provided that the file has a "YAML Front Matter":../frontmatter section, it will be transformed by Jekyll. The same will happen for any <code>.html</code>, <code>.markdown</code>, <code>.md</code>, or <code>.textile</code> file in your site's root directory or directories not listed above. |
+| Other Files/Folders | Every other directory and file except for those listed above—such as <code>css</code> and <code>images</code> folders, <code>favicon.ico</code> files, and so forth—will be transferred over verbatim to the generated site. There's plenty of "sites already using Jekyll":../sites if you're curious as to how they're laid out. |
View
@@ -281,7 +281,7 @@ body > footer .align-right img {
border-radius: 10px;
padding: 40px 40px 30px;
box-shadow: 0 3px 10px rgba(0,0,0,.1);
- min-height: 800px;
+ min-height: 860px;
}
.docs aside {
@@ -406,7 +406,7 @@ pre, code {
line-height: 1.8em;
}
-.highlight, p > pre, p > code {
+.highlight, p > pre, p > code, td > code {
background: #333;
color: #fff;
border-radius: 5px;
@@ -505,7 +505,7 @@ table {
box-shadow: 0 1px 3px rgba(0,0,0,.3);
}
-thead {
+.thead {
border-top-left-radius: 5px;
border-top-right-radius: 5px;
color: #fff;
@@ -520,27 +520,19 @@ thead {
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#3a3a3a', endColorstr='#1e1e1e',GradientType=0 );
}
-thead th {
+.thead th {
position: relative;
box-shadow: inset 0 1px 0 rgba(255,255,255,.1);
}
-thead th:first-child {
+.thead th:first-child {
border-top-left-radius: 5px;
}
-thead th:last-child {
+.thead th:last-child {
border-top-right-radius: 5px;
}
-td {
- padding: .5em .75em;
-}
-
-td p {
- margin: 0;
-}
-
th {
text-transform: uppercase;
font-size: 16px;
@@ -549,7 +541,11 @@ th {
color: #888;
}
-tbody td {
+td {
+ font-size: 16px;
+ line-height: 1.5em;
+ padding: .5em .75em;
+ margin: 0;
border-top: 1px solid rgba(0,0,0,.1);
box-shadow: inset 0 1px 0 rgba(255,255,255,.1);
background: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDEgMSIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+CiAgPGxpbmVhckdyYWRpZW50IGlkPSJncmFkLXVjZ2ctZ2VuZXJhdGVkIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjAlIiB5MT0iMCUiIHgyPSIwJSIgeTI9IjEwMCUiPgogICAgPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2ZmZmZmZiIgc3RvcC1vcGFjaXR5PSIwLjEiLz4KICAgIDxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iI2ZmZmZmZiIgc3RvcC1vcGFjaXR5PSIwIi8+CiAgPC9saW5lYXJHcmFkaWVudD4KICA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMSIgaGVpZ2h0PSIxIiBmaWxsPSJ1cmwoI2dyYWQtdWNnZy1nZW5lcmF0ZWQpIiAvPgo8L3N2Zz4=);
@@ -562,11 +558,7 @@ tbody td {
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#1affffff', endColorstr='#00ffffff',GradientType=0 );
}
-td p {
- font-size: 16px;
-}
-
-td p code {
+td code {
font-size: 14px;
}