Skip to content

Commit 288e3d1

Browse files
rabanti-githubrabanti-github
committed
Updated documentation / formal changes
1 parent 1829b61 commit 288e3d1

11 files changed

Lines changed: 190 additions & 57 deletions

File tree

‎Docs.IndexGenerator/Config/plugin-config.json‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,37 @@
44
"id": "NanoXLSX.Core",
55
"title": "NanoXLSX.Core API",
66
"path": "NanoXLSX.Core",
7-
"description": "Core library"
7+
"description": "Core library",
8+
"repository": "https://github.com/rabanti-github/NanoXLSX",
9+
"repositoryDisplayName": "NanoXLSX",
10+
"bundled": true
811
},
912
{
1013
"id": "NanoXLSX.Reader",
1114
"title": "NanoXLSX.Reader API",
1215
"path": "NanoXLSX.Reader",
13-
"description": "Reader component, to load XLSX files"
16+
"description": "Reader component, to load XLSX files",
17+
"repository": "https://github.com/rabanti-github/NanoXLSX",
18+
"repositoryDisplayName": "NanoXLSX",
19+
"bundled": true
1420
},
1521
{
1622
"id": "NanoXLSX.Writer",
1723
"title": "NanoXLSX.Writer API",
1824
"path": "NanoXLSX.Writer",
19-
"description": "Writer component, to save XLSX files"
25+
"description": "Writer component, to save XLSX files",
26+
"repository": "https://github.com/rabanti-github/NanoXLSX",
27+
"repositoryDisplayName": "NanoXLSX",
28+
"bundled": true
29+
},
30+
{
31+
"id": "NanoXLSX.Formatting",
32+
"title": "NanoXLSX.Formatter API",
33+
"path": "https://rabanti-github.github.io/NanoXLSX.Formatting",
34+
"description": "Extension managing advanced cell formatting",
35+
"repository": "https://github.com/rabanti-github/NanoXLSX.Formatting",
36+
"repositoryDisplayName": "NanoXLSX.Formatting",
37+
"bundled": true
2038
}
2139
]
2240
}

‎Docs.IndexGenerator/Output/index.html‎

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ <h2>API Documentation</h2>
2626

2727
<p class="version">Version 2.6.7</p>
2828

29-
<br>
3029
<hr>
31-
<br>
3230

3331
<h1>
3432
<img src="NanoXLSX.png"
@@ -37,10 +35,8 @@ <h1>
3735
NanoXLSX v3.x
3836
</h1>
3937

40-
<p>
41-
NanoXLSX is a library to generate and read Microsoft Excel files (XLSX) in an easy and native way.<br>
42-
The library is modular and consists of one core and several optional dependencies.<br>This documentation page contains the links to all relevant documentation sub-pages.
43-
<p>
38+
<p>NanoXLSX is a library to generate and read Microsoft Excel files (XLSX) in an easy and native way.</p>
39+
<p>The library is modular and consists of one core and several optional dependencies.<br>This documentation page contains the links to all relevant documentation sub-pages.</p>
4440

4541
<hr>
4642

@@ -60,12 +56,36 @@ <h2>Meta Package v3.0.0-rc.7</h2>
6056

6157
<section>
6258
<h2>Dependency Package Documentation</h2>
63-
<ul class="list">
64-
<li><a href="NanoXLSX.Core/index.html"><strong>NanoXLSX.Core API</strong></a> — Core library</li>
65-
<li><a href="NanoXLSX.Reader/index.html"><strong>NanoXLSX.Reader API</strong></a> — Reader component, to load XLSX files</li>
66-
<li><a href="NanoXLSX.Writer/index.html"><strong>NanoXLSX.Writer API</strong></a> — Writer component, to save XLSX files</li>
59+
<table class="list">
60+
<tr>
61+
<td>Package</td><td>Description</td><td>Bundled</td><td>Repository</td>
62+
</tr>
63+
<tr>
64+
<td><a href="NanoXLSX.Core/index.html"><strong>NanoXLSX.Core API</strong></a></td>
65+
<td>Core library</td>
66+
<td>True</td>
67+
<td><a href="https://github.com/rabanti-github/NanoXLSX" target="_blank" rel="noopener">NanoXLSX</a></td>
68+
</tr>
69+
<tr>
70+
<td><a href="NanoXLSX.Reader/index.html"><strong>NanoXLSX.Reader API</strong></a></td>
71+
<td>Reader component, to load XLSX files</td>
72+
<td>True</td>
73+
<td><a href="https://github.com/rabanti-github/NanoXLSX" target="_blank" rel="noopener">NanoXLSX</a></td>
74+
</tr>
75+
<tr>
76+
<td><a href="NanoXLSX.Writer/index.html"><strong>NanoXLSX.Writer API</strong></a></td>
77+
<td>Writer component, to save XLSX files</td>
78+
<td>True</td>
79+
<td><a href="https://github.com/rabanti-github/NanoXLSX" target="_blank" rel="noopener">NanoXLSX</a></td>
80+
</tr>
81+
<tr>
82+
<td><a href="https://rabanti-github.github.io/NanoXLSX.Formatting/index.html"><strong>NanoXLSX.Formatter API</strong></a></td>
83+
<td>Extension managing advanced cell formatting</td>
84+
<td>True</td>
85+
<td><a href="https://github.com/rabanti-github/NanoXLSX.Formatting" target="_blank" rel="noopener">NanoXLSX.Formatting</a></td>
86+
</tr>
6787

68-
</ul>
88+
</table>
6989
</section>
7090
</main>
7191
</body>

‎Docs.IndexGenerator/Output/style.css‎

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial; color: #222; margin: 32px; }
2-
main { max-width: 900px; margin: auto; }
3-
header h1 { margin: 0; }
4-
.version { color: #666; margin-top: 4px; }
5-
.list { line-height: 1.8; }
6-
.list a { color: #0366d6; text-decoration: none; }
7-
.list a:hover { text-decoration: underline; }
2+
hr {
3+
margin: 2rem 0;
4+
border: none;
5+
border-top: 1px solid #e5e7eb;
6+
}
7+
main {
8+
max-width: 900px;
9+
margin: 2rem auto;
10+
padding: 0 1rem;
11+
font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
12+
}
13+
14+
header h1 {
15+
margin: 0;
16+
}
17+
818
.version {
919
display: inline-block;
1020
background-color: #f2f4f7;
@@ -16,3 +26,37 @@ header h1 { margin: 0; }
1626
border: 1px solid #d0d7de;
1727
margin-top: 8px;
1828
}
29+
30+
table.list {
31+
width: 100%;
32+
border-collapse: collapse;
33+
margin-top: 1rem;
34+
font-size: 0.95rem;
35+
}
36+
37+
table.list th,
38+
table.list td {
39+
padding: 0.6rem 0.75rem;
40+
text-align: left;
41+
border-bottom: 1px solid #e5e7eb;
42+
vertical-align: top;
43+
}
44+
45+
table.list th {
46+
font-weight: 600;
47+
background-color: #f9fafb;
48+
border-bottom: 2px solid #d0d7de;
49+
}
50+
51+
table.list tr:hover {
52+
background-color: #f6f8fa;
53+
}
54+
55+
table.list a {
56+
color: #0366d6;
57+
text-decoration: none;
58+
}
59+
60+
table.list a:hover {
61+
text-decoration: underline;
62+
}

‎Docs.IndexGenerator/Program.cs‎

Lines changed: 67 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace Docs.IndexGenerator
1414
{
1515
#nullable enable
16-
internal record DocEntry(string Id, string Title, string Path, string? Description);
16+
internal record DocEntry(string Id, string Title, string Path, string? Description, string? Repository, string? RepositoryDisplayName, bool Bundled);
1717
internal record RootConfig(string ProjectName, string BaseDescription, string RootDescription);
1818
internal record MetaPackageConfig(string PackageName, string Version, string? Description);
1919
internal record PluginConfig(DocEntry[] Entries);
@@ -115,9 +115,7 @@ static int Main(string[] args)
115115
116116
<p class=""version"">Version 2.6.7</p>
117117
118-
<br>
119118
<hr>
120-
<br>
121119
122120
<h1>
123121
<img src=""NanoXLSX.png""
@@ -126,10 +124,8 @@ static int Main(string[] args)
126124
{EscapeHtml(rootConfig.ProjectName)} v3.x
127125
</h1>
128126
129-
<p>
130-
{EscapeHtml(rootConfig.BaseDescription)}<br>
131-
{EscapeHtml(rootConfig.RootDescription)}
132-
<p>
127+
<p>{EscapeHtml(rootConfig.BaseDescription)}</p>
128+
<p>{EscapeHtml(rootConfig.RootDescription)}</p>
133129
134130
<hr>
135131
@@ -146,9 +142,12 @@ static int Main(string[] args)
146142
147143
<section>
148144
<h2>Dependency Package Documentation</h2>
149-
<ul class=""list"">
145+
<table class=""list"">
146+
<tr>
147+
<td>Package</td><td>Description</td><td>Bundled</td><td>Repository</td>
148+
</tr>
150149
{GenerateListItems(pluginConfig)}
151-
</ul>
150+
</table>
152151
</section>
153152
</main>
154153
</body>
@@ -158,12 +157,22 @@ static int Main(string[] args)
158157

159158
// style.css
160159
string css = @"body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial; color: #222; margin: 32px; }
161-
main { max-width: 900px; margin: auto; }
162-
header h1 { margin: 0; }
163-
.version { color: #666; margin-top: 4px; }
164-
.list { line-height: 1.8; }
165-
.list a { color: #0366d6; text-decoration: none; }
166-
.list a:hover { text-decoration: underline; }
160+
hr {
161+
margin: 2rem 0;
162+
border: none;
163+
border-top: 1px solid #e5e7eb;
164+
}
165+
main {
166+
max-width: 900px;
167+
margin: 2rem auto;
168+
padding: 0 1rem;
169+
font-family: system-ui, -apple-system, BlinkMacSystemFont, ""Segoe UI"", Roboto, sans-serif;
170+
}
171+
172+
header h1 {
173+
margin: 0;
174+
}
175+
167176
.version {
168177
display: inline-block;
169178
background-color: #f2f4f7;
@@ -175,6 +184,40 @@ static int Main(string[] args)
175184
border: 1px solid #d0d7de;
176185
margin-top: 8px;
177186
}
187+
188+
table.list {
189+
width: 100%;
190+
border-collapse: collapse;
191+
margin-top: 1rem;
192+
font-size: 0.95rem;
193+
}
194+
195+
table.list th,
196+
table.list td {
197+
padding: 0.6rem 0.75rem;
198+
text-align: left;
199+
border-bottom: 1px solid #e5e7eb;
200+
vertical-align: top;
201+
}
202+
203+
table.list th {
204+
font-weight: 600;
205+
background-color: #f9fafb;
206+
border-bottom: 2px solid #d0d7de;
207+
}
208+
209+
table.list tr:hover {
210+
background-color: #f6f8fa;
211+
}
212+
213+
table.list a {
214+
color: #0366d6;
215+
text-decoration: none;
216+
}
217+
218+
table.list a:hover {
219+
text-decoration: underline;
220+
}
178221
";
179222
File.WriteAllText(Path.Combine(outDir, "style.css"), css);
180223
var assetDest = Path.Combine(outDir, "NanoXLSX.png");
@@ -195,8 +238,15 @@ static string GenerateListItems(PluginConfig cfg)
195238
var sb = new System.Text.StringBuilder();
196239
foreach (var e in cfg.Entries)
197240
{
198-
string href = $"{Uri.EscapeDataString(e.Path)}/index.html";
199-
sb.AppendLine($" <li><a href=\"{href}\"><strong>{EscapeHtml(e.Title)}</strong></a> — {EscapeHtml(e.Description ?? "")}</li>");
241+
string repoUrl = Uri.EscapeUriString(e.Repository);
242+
string docUrl = $"{Uri.EscapeUriString(e.Path)}/index.html";
243+
sb.AppendLine(" <tr>");
244+
sb.AppendLine($" <td><a href=\"{docUrl}\"><strong>{EscapeHtml(e.Title)}</strong></a></td>");
245+
sb.AppendLine($" <td>{EscapeHtml(e.Description ?? "")}</td>");
246+
sb.AppendLine($" <td>{EscapeHtml(e.Bundled.ToString())}</td>");
247+
sb.AppendLine($" <td><a href=\"{repoUrl}\" target=\"_blank\" rel=\"noopener\">{EscapeHtml(e.RepositoryDisplayName)}</a></td>");
248+
sb.AppendLine(" </tr>");
249+
200250
}
201251
return sb.ToString();
202252
}

‎NanoXLSX.Core/Documentation/projectNumber.doxygen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
PROJECT_NUMBER = 3.0.0-rc.5
1+
PROJECT_NUMBER = 3.0.0-rc.6

‎NanoXLSX.Core/NanoXLSX.Core.csproj‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<GenerateDocumentationFile>True</GenerateDocumentationFile>
2222
<PackageTags>Excel Office XLSX</PackageTags>
2323
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
24-
<Version>3.0.0-rc.5</Version>
25-
<AssemblyVersion>3.0.0-rc.5</AssemblyVersion>
26-
<FileVersion>3.0.0-rc.5</FileVersion>
24+
<Version>3.0.0-rc.6</Version>
25+
<AssemblyVersion>3.0.0-rc.6</AssemblyVersion>
26+
<FileVersion>3.0.0-rc.6</FileVersion>
2727
<RepositoryType>git</RepositoryType>
2828
<PackageReadmeFile>README.md</PackageReadmeFile>
2929
<PackageReleaseNotes>Please see https://github.com/rabanti-github/NanoXLSX/blob/master/Changelog.md for the release notes</PackageReleaseNotes>

‎NanoXLSX.Reader/Documentation/projectNumber.doxygen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
PROJECT_NUMBER = 3.0.0-rc.5
1+
PROJECT_NUMBER = 3.0.0-rc.6

‎NanoXLSX.Reader/NanoXLSX.Reader.csproj‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2121
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2222
<PackageTags>Excel Office XLSX Reader</PackageTags>
23-
<Version>3.0.0-rc.5</Version>
24-
<AssemblyVersion>3.0.0-rc.5</AssemblyVersion>
25-
<FileVersion>3.0.0-rc.5</FileVersion>
23+
<Version>3.0.0-rc.6</Version>
24+
<AssemblyVersion>3.0.0-rc.6</AssemblyVersion>
25+
<FileVersion>3.0.0-rc.6</FileVersion>
2626
<RepositoryType>git</RepositoryType>
2727
<PackageReadmeFile>README.md</PackageReadmeFile>
2828
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -51,18 +51,18 @@
5151
<ItemGroup Condition="'$(Configuration)' == 'Debug'">
5252
<ProjectReference Include="..\NanoXLSX.Core\NanoXLSX.Core.csproj" />
5353
</ItemGroup>
54-
<ItemGroup Condition="'$(Configuration)' == 'Release'">
55-
<!--<PackageReference Include="NanoXLSX.Core" Version="3.0.*" /> -->
56-
<PackageReference Include="NanoXLSX.Core" Version="3.0.0-rc.5" />
57-
</ItemGroup>
5854
<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
5955
<Exec Command="@echo off&#xD;&#xA;echo PROJECT_NUMBER = $(Version) &gt; &quot;$(ProjectDir)Documentation\projectNumber.doxygen&quot;&#xD;&#xA;echo PROJECT_NAME = $(ProjectName) &gt; &quot;$(ProjectDir)Documentation\projectName.doxygen&quot;&#xD;&#xA;echo HTML_OUTPUT = ../../docs/$(ProjectName) &gt; &quot;$(ProjectDir)Documentation\outputDirectory.doxygen&quot;&#xD;&#xA;echo HTML_OUTPUT = ../../docs/$(ProjectName) &gt; &quot;$(ProjectDir)Documentation\htmlOutput.doxygen&quot;" />
6056
</Target>
6157
<ItemGroup>
6258
<None Include="Documentation\NanoXLSXlib.png" Pack="true" PackagePath="\" />
6359
<None Include="README.md" Pack="true" PackagePath="\" />
6460
</ItemGroup>
65-
<ItemGroup>
66-
<PackageReference Include="NanoXLSX.Core" Version="3.0.0-rc.5" />
61+
<ItemGroup Condition="'$(Configuration)' == 'Debug'">
62+
<ProjectReference Include="..\NanoXLSX.Core\NanoXLSX.Core.csproj" />
63+
</ItemGroup>
64+
<ItemGroup Condition="'$(Configuration)' == 'Release'">
65+
<!--<PackageReference Include="NanoXLSX.Core" Version="3.0.*" /> -->
66+
<PackageReference Include="NanoXLSX.Core" Version="3.0.0-rc.6" />
6767
</ItemGroup>
6868
</Project>

‎NanoXLSX.Writer/Documentation/projectNumber.doxygen‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
PROJECT_NUMBER = 3.0.0-rc.5
1+
PROJECT_NUMBER = 3.0.0-rc.6

‎NanoXLSX.Writer/NanoXLSX.Writer.csproj‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2121
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2222
<PackageTags>Excel Office XLSX Writer</PackageTags>
23-
<Version>3.0.0-rc.5</Version>
24-
<AssemblyVersion>3.0.0-rc.5</AssemblyVersion>
25-
<FileVersion>3.0.0-rc.5</FileVersion>
23+
<Version>3.0.0-rc.6</Version>
24+
<AssemblyVersion>3.0.0-rc.6</AssemblyVersion>
25+
<FileVersion>3.0.0-rc.6</FileVersion>
2626
<RepositoryType>git</RepositoryType>
2727
<PackageReadmeFile>README.md</PackageReadmeFile>
2828
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -62,7 +62,7 @@
6262
</ItemGroup>
6363
<ItemGroup Condition="'$(Configuration)' == 'Release'">
6464
<!--<PackageReference Include="NanoXLSX.Core" Version="3.0.*" /> -->
65-
<PackageReference Include="NanoXLSX.Core" Version="3.0.0-rc.5" />
65+
<PackageReference Include="NanoXLSX.Core" Version="3.0.0-rc.6" />
6666
</ItemGroup>
6767
<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
6868
<Exec Command="@echo off&#xD;&#xA;echo PROJECT_NUMBER = $(Version) &gt; &quot;$(ProjectDir)Documentation\projectNumber.doxygen&quot;&#xD;&#xA;echo PROJECT_NAME = $(ProjectName) &gt; &quot;$(ProjectDir)Documentation\projectName.doxygen&quot;&#xD;&#xA;echo HTML_OUTPUT = ../../docs/$(ProjectName) &gt; &quot;$(ProjectDir)Documentation\outputDirectory.doxygen&quot;&#xD;&#xA;echo HTML_OUTPUT = ../../docs/$(ProjectName) &gt; &quot;$(ProjectDir)Documentation\htmlOutput.doxygen&quot;" />

0 commit comments

Comments
 (0)