github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Docs] Update docfx and remove tocFilter hack. (#3010)

Browse Source 
* Update docfx and remove tocFilter hack.

docfx PR 9912 fixed the TOC filter value not being kept between page loads.
This removes the hack I used to get around it, but keeps the scroll code.

* Update docs workflow.
This commit is contained in:
Nora
2024-09-17 19:10:43 +02:00
committed by GitHub
parent 433bdc2a51
commit de8da0d3b9
3 changed files with 8 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/docs.yml vendored
View File

@@ -27,7 +27,7 @@ jobs:
dotnet-version: 8.0.x dotnet-version: 8.0.x
- name: Setup DocFX - name: Setup DocFX
run: dotnet tool install -g docfx --version 2.76.0 run: dotnet tool install -g docfx --version 2.77.0
- name: Build DNet docs - name: Build DNet docs
run: docfx docs/docfx.json run: docfx docs/docfx.json

2
docs/README.md
View File

@@ -4,7 +4,7 @@ The documentation for the Discord.Net library uses [DocFX][docfx-main].
Instructions for installing this tool can be found [here][docfx-installing]. Instructions for installing this tool can be found [here][docfx-installing].
> [!IMPORTANT] > [!IMPORTANT]
> You must use DocFX version **2.76.0** for everything to work correctly. > You must use DocFX version **2.77.0** for everything to work correctly.
1. Navigate to the root of the repository. 1. Navigate to the root of the repository.
2. Build the docs using `docfx docs/docfx.json`. Add the `--serve` 2. Build the docs using `docfx docs/docfx.json`. Add the `--serve`

23
docs/_template/material/public/main.js vendored
View File

@@ -22,29 +22,18 @@
{ {
// Ugly hack to improve toc filter. // Ugly hack to improve toc filter.
let target = document.getElementById("toc"); let target = document.getElementById("toc");
if(!target) return; if (!target) return;
let config = { attributes: false, childList: true, subtree: true }; let config = { attributes: false, childList: true, subtree: true };
let observer = new MutationObserver((list) => let observer = new MutationObserver((list) =>
{ {
for(const mutation of list) for (const mutation of list)
{ {
if(mutation.type === "childList" && mutation.target == target) if (mutation.type === "childList" && mutation.target == target)
{ {
let filter = target.getElementsByClassName("form-control")[0];
let filterValue = localStorage.getItem("tocFilter");
let scrollValue = localStorage.getItem("tocScroll"); let scrollValue = localStorage.getItem("tocScroll");
if(filterValue && filterValue !== "")
{
filter.value = filterValue;
let inputEvent = new Event("input");
filter.dispatchEvent(inputEvent);
}
// Add event to store scroll pos. // Add event to store scroll pos.
let tocDiv = target.getElementsByClassName("flex-fill")[0]; let tocDiv = target.getElementsByClassName("flex-fill")[0];
@@ -56,7 +45,7 @@
} }
}); });
if(scrollValue && scrollValue >= 0) if (scrollValue && scrollValue >= 0)
{ {
tocDiv.scroll(0, scrollValue); tocDiv.scroll(0, scrollValue);
} }