mirror of
https://github.com/litruv/Docs-Viewer.git
synced 2026-07-24 02:36:07 +10:00
add show docs link to config
This commit is contained in:
@@ -203,10 +203,10 @@ For improved SEO and social sharing, you can use a Cloudflare Worker to dynamica
|
|||||||
|
|
||||||
### index.json
|
### index.json
|
||||||
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"defaultPage": "home",
|
"defaultPage": "home",
|
||||||
|
"showDocsLink": true,
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"title": "Site Title",
|
"title": "Site Title",
|
||||||
"description": "Site description",
|
"description": "Site description",
|
||||||
@@ -226,6 +226,8 @@ For improved SEO and social sharing, you can use a Cloudflare Worker to dynamica
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The `showDocsLink` option controls whether a "Docs" link is shown in the UI navigation. Set to `false` to hide it.
|
||||||
|
|
||||||
The build process generates the documents part for `index.json`
|
The build process generates the documents part for `index.json`
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,13 @@
|
|||||||
|
/**
|
||||||
|
* Shows or hides the Docs link in the sidebar based on config.
|
||||||
|
* @param {boolean} show - Whether to show the Docs link.
|
||||||
|
*/
|
||||||
|
setShowDocsLink(show) {
|
||||||
|
const docsLink = document.querySelector('.github-link');
|
||||||
|
if (docsLink) {
|
||||||
|
docsLink.style.display = show ? '' : 'none';
|
||||||
|
}
|
||||||
|
}
|
||||||
/**
|
/**
|
||||||
* Service responsible for DOM manipulation and UI rendering.
|
* Service responsible for DOM manipulation and UI rendering.
|
||||||
* @class DOMService
|
* @class DOMService
|
||||||
|
|||||||
@@ -172,6 +172,9 @@ class Documentation {
|
|||||||
this.loadCustomCSS(data.customCSS);
|
this.loadCustomCSS(data.customCSS);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Show/hide Docs link in sidebar
|
||||||
|
this.domService.setShowDocsLink(data.showDocsLink !== false);
|
||||||
|
|
||||||
this.searchService.buildSearchIndex(this.indexData.documents);
|
this.searchService.buildSearchIndex(this.indexData.documents);
|
||||||
this.domService.setupSearch(this.searchService);
|
this.domService.setupSearch(this.searchService);
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user