Skip to content

update docs after latest changes #8

New issue

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

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tieske merged 1 commit into from
Aug 23, 2026
Merged

update docs after latest changes #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc_topics/01-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,11 @@ Here's a list of things to do when using this template:
- Lua (`project`): "local prj = require '`project`'"


* [Go to the template on Github and create a new repo from it](https://github.com/Tieske/project.lua/generate),
set the "`[short-description]`".
* [Go to the template on Github and create a new repo from it](https://github.com/Tieske/project.lua/generate)

* In the new repo settings, go to "Pages", and select branch "`main`" and folder "`/docs`".

* On the main repo page edit the project details; add the link to the documentation.
* On the main repo page edit the project details; set the "short-description" and add the link to the documentation.

* Clone the repo locally.

Expand Down
16 changes: 12 additions & 4 deletions docs/examples/example1.lua.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
<h1>[repo-name]</h1>


<ul>
<li><a href="../index.html">Index</a></li>
</ul>



Expand All @@ -36,7 +39,11 @@ <h2>Examples</h2>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../index.html">project</a></li>
<li><a href="../modules/project.html">project</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/module-name.html">module-name</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
Expand All @@ -55,8 +62,8 @@ <h2>example1.lua</h2>
<span class="comment">-- example to add to documentation
</span>
<span class="keyword">for</span> key, value <span class="keyword">in</span> <span class="global">pairs</span>(_G) <span class="keyword">do</span>
<span class="keyword">if</span> key:sub(<span class="number">1</span>,<span class="number">1</span>) == <span class="string">"_"</span> <span class="keyword">and</span> <span class="global">type</span>(value) == <span class="string">"string"</span> <span class="keyword">then</span>
key = key:match(<span class="string">"^_+(.+)$"</span>)
<span class="keyword">if</span> key:<span class="function-name">sub</span>(<span class="number">1</span>,<span class="number">1</span>) == <span class="string">"_"</span> <span class="keyword">and</span> <span class="global">type</span>(value) == <span class="string">"string"</span> <span class="keyword">then</span>
key = key:<span class="function-name">match</span>(<span class="string">"^_+(.+)$"</span>)
<span class="global">print</span>(key, value)
<span class="keyword">end</span>
<span class="keyword">end</span></pre>
Expand All @@ -65,7 +72,8 @@ <h2>example1.lua</h2>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2026-08-23 11:50:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
117 changes: 45 additions & 72 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ <h1>[repo-name]</h1>



<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
<li><strong>project</strong></li>
<li><a href="modules/project.html">project</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="scripts/module-name.html">module-name</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
Expand All @@ -54,82 +54,55 @@ <h2>Examples</h2>

<div id="content">

<h1>Module <code>project</code></h1>
<p>This module does something.</p>
<p> Explain some basics, or the design.</p>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: Copyright (c) [copyright-year]-[copyright-year] [your-name]</li>
<li><strong>License</strong>: MIT, see <a href="topics/LICENSE.md.html#">LICENSE.md</a>.</li>
<li><strong>Author</strong>: [your-name]</li>
</ul>

<h2>[short-description]</h2>

<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="#do_something">do_something (what[, force=false])</a></td>
<td class="summary">Does something.</td>
<td class="name" nowrap><a href="modules/project.html">project</a></td>
<td class="summary">This module does something.</td>
</tr>
</table>
<h2>Scripts</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="scripts/module-name.html">module-name</a></td>
<td class="summary">CLI application.</td>
</tr>
</table>
<h2>Topics</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="topics/01-introduction.md.html">01-introduction.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/02-advanced.md.html">02-advanced.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/CHANGELOG.md.html">CHANGELOG.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/LICENSE.md.html">LICENSE.md</a></td>
<td class="summary"></td>
</tr>
</table>
<h2>Examples</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="examples/example1.lua.html">example1.lua</a></td>
<td class="summary"></td>
</tr>
</table>

<br/>
<br/>


<h2 class="section-header "><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "do_something"></a>
<strong>do_something (what[, force=false])</strong>
</dt>
<dd>
Does something.
It will do what you tell it.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">what</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">function</span></span>
the thing that has to be done
</li>
<li><span class="parameter">force</span>
<span class="types"><span class="type">boolean</span></span>
set to a truthy value to force it.
(<em>default</em> false)
</li>
</ul>

<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">boolean</span></span>
success</li>
<li>
<span class="types"><span class="type">nil</span> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
error message on failure</li>
</ol>



<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> success, err = project.do_something(<span class="string">"tell a lie"</span>, <span class="keyword">true</span>)
<span class="keyword">if</span> <span class="keyword">not</span> success <span class="keyword">then</span>
<span class="global">print</span>(<span class="string">"failed at lying; "</span>, err)
<span class="keyword">end</span></pre>
</ul>

</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2026-08-23 11:50:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
86 changes: 86 additions & 0 deletions docs/modules/project.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>[module-name] docs</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>[repo-name]</h1>


<ul>
<li><a href="../index.html">Index</a></li>
</ul>



<h2>Modules</h2>
<ul class="nowrap">
<li><strong>project</strong></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/module-name.html">module-name</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
<li><a href="../topics/02-advanced.md.html">2. Advanced topic</a></li>
<li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
<li><a href="../topics/LICENSE.md.html">MIT License</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/example1.lua.html">example1.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>project</code></h1>
<p>This module does something.</p>
<p> Explain some basics, or the design.</p>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: Copyright (c) [copyright-year]-[copyright-year] [your-name]</li>
<li><strong>License</strong>: MIT, see <a href="../topics/LICENSE.md.html#">LICENSE.md</a>.</li>
<li><strong>Author</strong>: [your-name]</li>
</ul>



<br/>
<br/>




</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2026-08-23 11:50:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
86 changes: 86 additions & 0 deletions docs/scripts/module-name.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>[module-name] docs</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>[repo-name]</h1>


<ul>
<li><a href="../index.html">Index</a></li>
</ul>



<h2>Scripts</h2>
<ul class="nowrap">
<li><strong>module-name</strong></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/project.html">project</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
<li><a href="../topics/02-advanced.md.html">2. Advanced topic</a></li>
<li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
<li><a href="../topics/LICENSE.md.html">MIT License</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/example1.lua.html">example1.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Script <code>module-name</code></h1>
<p>CLI application.</p>
<p> Description goes here.</p>
<h3>Usage:</h3>
<ul>
<pre class="example"># start the application from a shell
[module-name] --some --options=here
</pre>
</ul>



<br/>
<br/>




</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2026-08-23 11:50:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
Loading
Loading