Skip to content

Commit

Permalink
Docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
zabszk committed Dec 20, 2022
1 parent 9e29b04 commit c719830
Show file tree
Hide file tree
Showing 10 changed files with 430 additions and 27 deletions.
22 changes: 9 additions & 13 deletions NwPluginAPI.Docs/articles/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@
## [Intro](intro.md)

## [Getting Started](gettingstarted/gettingstarted.md)
* ### [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
* [IDE](gettingstarted-ide.md)
* [Visual studio](gettingstarted-ide.md#visual-studio-walkthrough)
* [Jetbrains rider](gettingstarted-ide.md#rider-walkthrough)
* [CLI](gettingstarted-cli.md)

* ### [Writing code](gettingstarted/gettingstarted.md#writing-the-code)
### [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
#### [IDE](gettingstarted/gettingstarted-ide.md)
#### [Visual studio](gettingstarted/gettingstarted-ide.md#visual-studio-walkthrough)
#### [Jetbrains rider](gettingstarted/gettingstarted-ide.md#rider-walkthrough)
#### [CLI](gettingstarted/gettingstarted-cli.md)
#### [Writing code](gettingstarted/gettingstarted.md#writing-the-code)

## [Code Prerequisites](gettingstarted/codeprerequisites.md)
* ### [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
* ### [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
* ### [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)


// TODO: Improve table of contents
### [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
### [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
### [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)
323 changes: 323 additions & 0 deletions NwPluginAPI.Docs/log.txt

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion docs/articles/gettingstarted/codeprerequisites.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="stylesheet" href="../../styles/singulink.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">

<meta property="docfx:rel" content="../../">
<meta property="docfx:newtab" content="true">
Expand Down Expand Up @@ -60,6 +60,10 @@
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>

<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
Nw Plugin API
Expand Down
6 changes: 5 additions & 1 deletion docs/articles/gettingstarted/gettingstarted-cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="stylesheet" href="../../styles/singulink.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">

<meta property="docfx:rel" content="../../">
<meta property="docfx:newtab" content="true">
Expand Down Expand Up @@ -60,6 +60,10 @@
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>

<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
Nw Plugin API
Expand Down
6 changes: 5 additions & 1 deletion docs/articles/gettingstarted/gettingstarted-ide.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="stylesheet" href="../../styles/singulink.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">

<meta property="docfx:rel" content="../../">
<meta property="docfx:newtab" content="true">
Expand Down Expand Up @@ -60,6 +60,10 @@
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>

<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
Nw Plugin API
Expand Down
6 changes: 5 additions & 1 deletion docs/articles/gettingstarted/gettingstarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="stylesheet" href="../../styles/singulink.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">

<meta property="docfx:rel" content="../../">
<meta property="docfx:newtab" content="true">
Expand Down Expand Up @@ -60,6 +60,10 @@
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>

<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
Nw Plugin API
Expand Down
6 changes: 5 additions & 1 deletion docs/articles/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="stylesheet" href="../styles/singulink.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
Expand Down Expand Up @@ -60,6 +60,10 @@
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>

<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
Nw Plugin API
Expand Down
56 changes: 54 additions & 2 deletions docs/articles/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,69 @@
<ul class="nav level1">
<li>
<span class="expand-stub"></span>
<a href="intro.html" class="sidebar-item" name="" title="Introduction">Introduction</a>
<a>Table of contents</a>


<ul class="nav level2">
<li>
<a href="intro.html" class="sidebar-item" name="" title="Intro">Intro</a>

</li>
<li>
<span class="expand-stub"></span>
<a href="gettingstarted/gettingstarted.html" class="sidebar-item" name="" title="Getting Started">Getting Started</a>


<ul class="nav level3">
<li>
<span class="expand-stub"></span>
<a href="gettingstarted/gettingstarted.html#environment-setup" class="sidebar-item" name="" title="Environment setup">Environment setup</a>


<ul class="nav level4">
<li>
<a href="gettingstarted/gettingstarted-ide.html" class="sidebar-item" name="" title="IDE">IDE</a>

</li>
<li>
<a href="gettingstarted/gettingstarted-ide.html#visual-studio-walkthrough" class="sidebar-item" name="" title="Visual studio">Visual studio</a>

</li>
<li>
<a href="gettingstarted/gettingstarted-ide.html#rider-walkthrough" class="sidebar-item" name="" title="Jetbrains rider">Jetbrains rider</a>

</li>
<li>
<a href="gettingstarted/gettingstarted-cli.html" class="sidebar-item" name="" title="CLI">CLI</a>

</li>
<li>
<a href="gettingstarted/gettingstarted.html#writing-the-code" class="sidebar-item" name="" title="Writing code">Writing code</a>

</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="gettingstarted/codeprerequisites.html" class="sidebar-item" name="" title="Code Preqrequisites">Code Preqrequisites</a>
<span class="expand-stub"></span>
<a href="gettingstarted/codeprerequisites.html" class="sidebar-item" name="" title="Code Prerequisites">Code Prerequisites</a>


<ul class="nav level3">
<li>
<a href="gettingstarted/codeprerequisites.html#the-plugin-class" class="sidebar-item" name="" title="The `Plugin` class">The `Plugin` class</a>

</li>
<li>
<a href="gettingstarted/codeprerequisites.html#the-config-class" class="sidebar-item" name="" title="The `Config` class">The `Config` class</a>

</li>
<li>
<a href="gettingstarted/codeprerequisites.html#event-handlers" class="sidebar-item" name="" title="Event handlers">Event handlers</a>

</li>
</ul>
</li>
</ul>
</li>
Expand Down
24 changes: 18 additions & 6 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"output": {
".html": {
"relative_path": "articles/gettingstarted/codeprerequisites.html",
"hash": "ALudVQeEGeQozdGhwjTeUNavLMjTc3QtwbjLoyd8jkA="
"hash": "IYrhXHI9iR3732M6F3H1ZST2doWYeoATvKPoPII/ayg="
}
},
"is_incremental": false,
Expand All @@ -42,7 +42,7 @@
"output": {
".html": {
"relative_path": "articles/gettingstarted/gettingstarted-cli.html",
"hash": "xK1eJmcTTVBC3pZfPfAps3BPEPSdCSIb4NR4zUTAVO8="
"hash": "b2Nl3QAd2Dn6QdpcweCvw+Bf5EpnE+rVrSSyPBexwis="
}
},
"is_incremental": false,
Expand All @@ -57,7 +57,7 @@
"output": {
".html": {
"relative_path": "articles/gettingstarted/gettingstarted-ide.html",
"hash": "ff93sLkMWf5tlynKgDQDlGgfnD1uwdOLK9fUUXYjruc="
"hash": "/6Blrqr40JhfRZWihrQLe+JIB5O+oBrY6otKHIC3ZDI="
}
},
"is_incremental": false,
Expand All @@ -69,7 +69,7 @@
"output": {
".html": {
"relative_path": "articles/gettingstarted/gettingstarted.html",
"hash": "6BF9+JvBL/fxoOPN8Xie7gWKP+6a2gxcIx5Xh44cEdg="
"hash": "LvRliLxpaYWtmZwJOmbX79c2Qeji2hCXxTZasVE0egc="
}
},
"is_incremental": false,
Expand All @@ -81,7 +81,19 @@
"output": {
".html": {
"relative_path": "articles/intro.html",
"hash": "PKDmUbg9t/TXOenlsGIG9VLpVjXqxXOo8pqNo8D94G4="
"hash": "RXvpib2PMefn1thS1RxQUQlw8Zx1B3Q3nQ97Rjw1Mfo="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "Toc",
"source_relative_path": "articles/toc.md",
"output": {
".html": {
"relative_path": "articles/toc.html",
"hash": "VCdc51sHLcfSiU37Uckh7j5ocChnizyc9FHx7Na0Mfo="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -127,7 +139,7 @@
"output": {
".html": {
"relative_path": "toc.html",
"hash": "DOs6EOFyofyeaf1yT2I6wtcX6vpDR+XmVv8FprVL1rw="
"hash": "nnUvgcXhMEXtNGGh2tnLFH8TXcFoGn6d2ZgosWs/vvQ="
}
},
"is_incremental": false,
Expand Down
2 changes: 1 addition & 1 deletion docs/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<ul class="nav level1">
<li>
<a>Articles</a>
<a href="articles/intro.html" class="sidebar-item" name="articles/toc.html" title="Articles">Articles</a>

</li>
<li>
Expand Down

0 comments on commit c719830

Please sign in to comment.