Publish site-pskov with en/ru docs
This commit is contained in:
@@ -64,9 +64,17 @@
|
||||
text-align: left;
|
||||
color: #444;
|
||||
}
|
||||
#footer
|
||||
{
|
||||
text-align: center;
|
||||
}
|
||||
#lang
|
||||
{
|
||||
float: right;
|
||||
}
|
||||
</style>
|
||||
<title>
|
||||
pskov_1.0.0
|
||||
PSKOV
|
||||
</title>
|
||||
</head>
|
||||
<body>
|
||||
@@ -74,6 +82,10 @@
|
||||
<strong id="title">PSKOV</strong>
|
||||
<a href="pskov_1.0.0.html">Tool</a>
|
||||
<a href="education.html">Education</a>
|
||||
<div id="lang">
|
||||
<a href="../en/education.03.site.html">EN</a>
|
||||
<a href="../ru/education.03.site.html">RU</a>
|
||||
</div>
|
||||
</div>
|
||||
<center><h1>
|
||||
Education: 03. Site
|
||||
@@ -101,7 +113,7 @@ Education: 03. Site
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<ul>
|
||||
<li><a href="#inspiration">01. Inspiration</a></li>
|
||||
<li><a href="#cfg">02. Investigate <code>cfg</code> file</a></li>
|
||||
<li><a href="#cfg">02. Investigate <code>pskov.cfg</code> file</a></li>
|
||||
<li><a href="#item">03. Investigate <code>item.template</code> file</a></li>
|
||||
<li><a href="#md">04. Investigate <code>about.md</code> and <code>cv.md</code> files</a></li>
|
||||
<li><a href="#lfsa">05. Launch LFSA</a></li>
|
||||
@@ -118,19 +130,19 @@ Education: 03. Site
|
||||
</ul>
|
||||
<p>Some time later you have the following files in your <a href="https://github.com/OGStudio/site-pskov-sample/tree/master/01.TwoPages">site directory</a>:</p>
|
||||
<ul>
|
||||
<li>cfg</li>
|
||||
<li>pskov.cfg</li>
|
||||
<li>item.template</li>
|
||||
<li>about.md</li>
|
||||
<li>cv.md</li>
|
||||
</ul>
|
||||
<p>Let's look at their contents closer.</p>
|
||||
<p><a name="cfg"/></p>
|
||||
<h2 id="02investigatecfgfile">02. Investigate <code>cfg</code> file</h2>
|
||||
<p><code>cfg</code> file has the following contents:</p>
|
||||
<h2 id="02investigatepskovcfgfile">02. Investigate <code>pskov.cfg</code> file</h2>
|
||||
<p><code>pskov.cfg</code> file has the following contents:</p>
|
||||
<pre><code>input = .
|
||||
item = item.template
|
||||
</code></pre>
|
||||
<p><code>cfg</code> is an <a href="https://en.wikipedia.org/wiki/INI_file">INI file</a> with the following keys specified:</p>
|
||||
<p><code>pskov.cfg</code> is an <a href="https://en.wikipedia.org/wiki/INI_file">INI file</a> with the following keys specified:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -149,7 +161,7 @@ item = item.template
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>In our case, <code>item.template</code> file is located alongside <code>cfg</code>, so we use <code>.</code> to denote current directory.</p>
|
||||
<p>In our case, <code>item.template</code> file is located alongside <code>pskov.cfg</code>, so we use <code>.</code> to denote current directory.</p>
|
||||
<p><a name="item"/></p>
|
||||
<h2 id="03investigateitemtemplatefile">03. Investigate <code>item.template</code> file</h2>
|
||||
<p><code>item.template</code> file has the following contents:</p>
|
||||
@@ -192,7 +204,7 @@ PSKOV_ITEM_CONTENTS
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>PSKOV_ITEM_TITLE</code></td>
|
||||
<td>Provides title from <code>Title:</code> part of page's header section</td>
|
||||
<td>Value of <code>Title</code> key of the page's Markdown file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PSKOV_ITEM_CONTENTS</code></td>
|
||||
@@ -203,7 +215,7 @@ PSKOV_ITEM_CONTENTS
|
||||
<p><strong>Notes</strong>:</p>
|
||||
<ul>
|
||||
<li>other <strong>PSKOV</strong> constants are described later</li>
|
||||
<li>page's header section is described below</li>
|
||||
<li>page's Markdown file is described below</li>
|
||||
</ul>
|
||||
<p><a name="md"/></p>
|
||||
<h2 id="04investigateaboutmdandcvmdfiles">04. Investigate <code>about.md</code> and <code>cv.md</code> files</h2>
|
||||
@@ -231,17 +243,17 @@ PSKOV_ITEM_CONTENTS
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Header constant</th>
|
||||
<th>Header key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Title:</code></td>
|
||||
<td><code>Title</code></td>
|
||||
<td>Provides value for <code>PSKOV_ITEM_TITLE</code> constant when generating HTML out of Markdown</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Slug:</code></td>
|
||||
<td><code>Slug</code></td>
|
||||
<td>Tells <strong>PSKOV</strong> that particular Markdown file should be saved under <code><slug>.html</code> filename</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -267,7 +279,7 @@ PSKOV_ITEM_CONTENTS
|
||||
<p><a name="lfsa"/></p>
|
||||
<h2 id="05launchlfsa">05. Launch LFSA</h2>
|
||||
<p>Launch <a href="http://opengamestudio.org/lfsa">LFSA</a> so that it points to directory with the files we just observed:</p>
|
||||
<pre><code>$ /path/to/lfsa-201905.py /path/to/dir/01.TwoPages
|
||||
<pre><code>$ /path/to/lfsa_1.0.0.py /path/to/dir/01.TwoPages
|
||||
</code></pre>
|
||||
<p>You should see output similar to this:</p>
|
||||
<pre><code>DIR: '/Users/kornerr/p/site-pskov-sample/01.TwoPages'
|
||||
@@ -279,8 +291,8 @@ PORT: '8000'
|
||||
<ul>
|
||||
<li>Go to <a href="http://opengamestudio.org/pskov">Tool</a> page</li>
|
||||
<li>Make sure<ul>
|
||||
<li><code>Path:</code> points to the same directory you specified before</li>
|
||||
<li><code>Input directory:</code> and <code>Item template:</code> have values from <code>cfg</code></li></ul></li>
|
||||
<li><code>Path</code> points to the same directory you specified before</li>
|
||||
<li><code>Input directory</code> and <code>Item template</code> have values from <code>pskov.cfg</code></li></ul></li>
|
||||
<li>Press <code>Generate</code> button to generate HTML files right where Markdown ones reside</li>
|
||||
<li>Open generated <code>about.html</code> from the site's directory</li>
|
||||
<li>You should see your web site running locally</li>
|
||||
@@ -288,7 +300,7 @@ PORT: '8000'
|
||||
<p><a name="summary"/></p>
|
||||
<h2 id="07summary">07. Summary</h2>
|
||||
<p>You have successfully generated a web site with two pages. <a href="http://opengamestudio.org/pskov/sample/01.TwoPages/about.html">Check out the result</a>.</p>
|
||||
<p>Introduced PSKOV constants include:</p>
|
||||
<p>Introduced <strong>PSKOV</strong> constants include:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -299,7 +311,7 @@ PORT: '8000'
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>PSKOV_ITEM_TITLE</code></td>
|
||||
<td>Provides title from <code>Title:</code> part of page's header section</td>
|
||||
<td>Value of <code>Title</code> key of the page's Markdown file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PSKOV_ITEM_CONTENTS</code></td>
|
||||
@@ -326,21 +338,21 @@ PORT: '8000'
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Introduced header constants include:</p>
|
||||
<p>Introduced header keys include:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Header constant</th>
|
||||
<th>Header key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Title:</code></td>
|
||||
<td><code>Title</code></td>
|
||||
<td>Provides value for <code>PSKOV_ITEM_TITLE</code> constant when generating HTML out of Markdown</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Slug:</code></td>
|
||||
<td><code>Slug</code></td>
|
||||
<td>Tells <strong>PSKOV</strong> that particular Markdown file should be saved under <code><slug>.html</code> filename</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -363,6 +375,11 @@ PORT: '8000'
|
||||
</tbody>
|
||||
</table>
|
||||
</div></center>
|
||||
<div id="footer">
|
||||
The site has been generated by <a href="http://opengamestudio.org/pskov">PSKOV</a>
|
||||
from <a href="http://github.com/ogstudio/site-pskov">this source code</a>.
|
||||
The site is hosted by <a href="https://pages.github.com">GitHub Pages</a>.
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
</script>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user