-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
51 changed files
with
3,806 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Singulink | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# SingulinkFX | ||
|
||
[![Chat on Discord](https://img.shields.io/discord/906246067773923490)](https://discord.gg/EkQhJFsBu6) | ||
|
||
**SingulinkFX** is a fully responsive [DocFX](https://dotnet.github.io/docfx/) template used for Singulink projects to produce documentation that is familiar to those used to browsing Microsoft's .NET documentation. | ||
|
||
**Features:** | ||
- Responsive layout for all device sizes. | ||
- Easily configurable colors and sidebar width. | ||
- Empty table columns are removed, so if you don't comment the parameters or return value on some methods then it won't display an empty description column. | ||
- The table of contents supports 4 levels of items to properly facilitate usage together with the [`separatePages` member layout](https://dotnet.github.io/docfx/reference/docfx-json-reference.html#memberlayout). | ||
- Contains optional style overrides optimized for displaying articles. | ||
- Includes [Bootstrap Icons](https://icons.getbootstrap.com/). | ||
|
||
### [Live Demo (Singulink.IO.FileSystem)](https://www.singulink.com/Docs/Singulink.IO.FileSystem/) | ||
|
||
![Method Page Screenshot](./screenshots/method.png) | ||
|
||
### About Singulink | ||
|
||
We are a small team of engineers and designers dedicated to building beautiful, functional and well-engineered software solutions. We offer very competitive rates as well as fixed-price contracts and welcome inquiries to discuss any custom development / project support needs you may have. | ||
|
||
Visit https://github.com/Singulink to see our full list of publicly available libraries and other open-source projects. | ||
|
||
## Installation | ||
|
||
1. Download the source or the zipped file from the [releases page](https://github.com/Singulink/SingulinkFX/releases). | ||
2. In your DocFX project folder, create a directory named `templates`, if it doesn't already exist. | ||
3. Copy the `singulinkfx` folder from this repository into the `templates` folder. | ||
4. In your `docfx.json` configuration file, add the `singulinkfx` path into the `build.template` property: | ||
```json | ||
"template": ["default", "templates/singulinkfx"] | ||
``` | ||
|
||
A real-world example of a .NET library using this template with articles can be found in the [Singulink.IO.FileSystem](https://github.com/Singulink/Singulink.IO.FileSystem) repository (check out the `Docs` folder). If you are new to DocFX you might also find it helpful for properly setting up the table of contents. | ||
|
||
## Versions and Upgrading | ||
|
||
### Version 3.x | ||
|
||
For use with DocFX v2.75 and above. | ||
|
||
### Version 2.x | ||
|
||
For use with DocFX v2.62 and above. | ||
|
||
The `memberpage-extras` plugin has been removed for version 2+ of the template. DocFX v2.62 no longer shows explicit interface members by default. Furthermore, the functionality to group explicit interface implementations into their own section in the table of contents has been merged into the DocFX codebase and an option for including explicit interface implementations is in the works so the plugin should no longer be necessary moving forward. | ||
|
||
### Version 1.x | ||
|
||
For DocFX versions older than v2.62 you should use [v1.1 of this template](https://github.com/Singulink/SingulinkFX/tree/v1.1). | ||
|
||
## Customization | ||
|
||
### Configuration | ||
|
||
The following is a sample `docfx.json` global metadata section that demonstrates the usage of the options this theme offers: | ||
```json | ||
"globalMetadata": { | ||
"_appTitle": "Singulink.IO.FileSystem", | ||
"_appName": "File System", | ||
"_appFaviconPath": "images/favicon.png", | ||
"_appLogoPath": "images/logo.png", | ||
"_appFooter": "<strong>DocFX + Singulink = ♥</strong>", | ||
"_copyrightFooter": "© Singulink. All rights reserved.", | ||
"_enableSearch": true, | ||
"_disableSideFilter": false, | ||
"_enableNewTab": true, | ||
"_disableContribution": false, | ||
"_disableBreadcrumb": false, | ||
} | ||
``` | ||
![Configuration Areas](./screenshots/configuration.png) | ||
|
||
### Colors and Layout | ||
|
||
You can change any color as well as the width of the side bar and font sizes for desktop and mobile views. The values are defined in the `styles/config.css` file. The recommended approach to changing the default values is to create another directory inside `templates` for your sub-theme that overrides these values in a `styles/main.css` file, and add your theme to the end of the list of templates in `docfx.json`. Your `main.css` file will be automatically referenced in the output, there is no need to override any other template files. | ||
|
||
### Custom Javascript | ||
|
||
The `styles/main.js` file can be used to add your own custom Javascript. The recommended approach is to create another directory inside `templates` for your sub-theme, add a `styles/main.js` file, and add your theme to the end of the list of templates in `docfx.json`. Your `main.js` file will be automatically referenced in the output, there is no need to override any other template files. | ||
|
||
### Article Styling | ||
|
||
Wrap your HTML or markdown in a `<div class="article"></div>` to activate styles that change heading styles and spacing to something more suitable for articles instead of API member docs. Supports up to 5 heading levels (`h1` to `h5` for HTML or `#` to `#####` for markdown). | ||
|
||
## More Screenshots | ||
|
||
### Desktop | ||
|
||
![Article Screenshot](./screenshots/article.png) | ||
|
||
![Namespace Page Screenshot](./screenshots/namespace.png) | ||
|
||
![Class Page Screenshot](./screenshots/class.png) | ||
|
||
### Mobile | ||
|
||
![Class Mobile Page Screenshot](./screenshots/class-mobile.png) | ||
|
||
![Nav Menu Mobile Screenshot](./screenshots/nav-mobile.png) | ||
|
||
## Attribution | ||
|
||
Special thanks to [@jbltx](https://github.com/jbltx) for creating [DiscordFX](https://github.com/jbltx/DiscordFX) which was a great starting point for this template. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 74 additions & 0 deletions
74
Docs/templates/SingulinkFX-3.0.2/singulinkfx/layout/_master.tmpl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
{{!include(/^styles/.*/)}} | ||
{{!include(/^fonts/.*/)}} | ||
{{!include(favicon.ico)}} | ||
{{!include(logo.svg)}} | ||
{{!include(search-stopwords.json)}} | ||
<!DOCTYPE html> | ||
<!--[if IE]><![endif]--> | ||
<html> | ||
{{>partials/head}} | ||
|
||
<body> | ||
<!-- Header required for docfx anchor scroll to work --> | ||
<header id="head"></header> | ||
<div class="top-navbar"> | ||
<a class="burger-icon" onclick="toggleMenu()"> | ||
<svg name="Hamburger" | ||
style="vertical-align: middle;" | ||
width="34" height="34" viewBox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg> | ||
</a> | ||
|
||
{{>partials/logo}} | ||
</div> | ||
|
||
<div class="body-content"> | ||
<div id="blackout" class="blackout" onclick="toggleMenu()"></div> | ||
|
||
<nav id="sidebar" role="navigation"> | ||
<div class="sidebar"> | ||
{{>partials/navbar}} | ||
<div class="sidebar-item-separator"></div> | ||
{{^_disableToc}} | ||
{{>partials/toc}} | ||
{{/_disableToc}} | ||
</div> | ||
{{>partials/footer}} | ||
</nav> | ||
|
||
<main class="main-panel"> | ||
{{#_enableSearch}} | ||
{{>partials/searchResults}} | ||
{{/_enableSearch}} | ||
|
||
|
||
|
||
<div role="main" class="hide-when-search" > | ||
{{^_disableBreadcrumb}} | ||
{{>partials/breadcrumb}} | ||
{{/_disableBreadcrumb}} | ||
|
||
{{^_disableContribution}} | ||
<div id="contribution"> | ||
{{#docurl}} | ||
<a href="{{docurl}}" class="contribution-link">{{__global.improveThisDoc}}</a> | ||
{{/docurl}} | ||
</div> | ||
{{/_disableContribution}} | ||
|
||
<article class="content wrap" id="_content" data-uid="{{uid}}"> | ||
{{!body}} | ||
</article> | ||
</div> | ||
|
||
{{#_copyrightFooter}} | ||
<div class="copyright-footer"> | ||
<span>{{_copyrightFooter}}</span> | ||
</div> | ||
{{/_copyrightFooter}} | ||
</main> | ||
</div> | ||
|
||
{{>partials/scripts}} | ||
</body> | ||
</html> |
4 changes: 4 additions & 0 deletions
4
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/footer.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
<div class="footer"> | ||
{{{_appFooter}}} | ||
{{^_appFooter}}<strong><a href='https://dotnet.github.io/docfx/'>DocFX</a> + <a href='https://www.singulink.com'>Singulink</a> = ♥</strong>{{/_appFooter}} | ||
</div> |
23 changes: 23 additions & 0 deletions
23
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/head.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title> | ||
<meta name="viewport" content="width=device-width"> | ||
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}"> | ||
<meta name="generator" content="docfx {{_docfxVersion}}"> | ||
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}} | ||
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}"> | ||
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet"> | ||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/night-owl.min.css"> | ||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous"> | ||
<link rel="stylesheet" href="{{_rel}}styles/config.css"> | ||
<link rel="stylesheet" href="{{_rel}}styles/singulink.css"> | ||
<link rel="stylesheet" href="{{_rel}}styles/main.css"> | ||
<meta property="docfx:navrel" content="{{_navRel}}"> | ||
<meta property="docfx:tocrel" content="{{_tocRel}}"> | ||
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}} | ||
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}} | ||
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}} | ||
</head> |
31 changes: 31 additions & 0 deletions
31
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/li.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<ul class="nav level{{level}}"> | ||
{{#items}} | ||
{{^dropdown}} | ||
<li> | ||
{{^leaf}} | ||
<span class="expand-stub"></span> | ||
{{/leaf}} | ||
{{#topicHref}} | ||
<a href="{{topicHref}}" class="sidebar-item" name="{{tocHref}}" title="{{name}}">{{name}}</a> | ||
{{/topicHref}} | ||
{{^topicHref}} | ||
<a>{{{name}}}</a> | ||
{{/topicHref}} | ||
|
||
{{^leaf}} | ||
{{>partials/li}} | ||
{{/leaf}} | ||
</li> | ||
{{/dropdown}} | ||
{{#dropdown}} | ||
<li class="dropdown"> | ||
<a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">{{name}} <span class="caret"></span></a> | ||
<ul class="dropdown-menu level{{level}}"> | ||
{{>partials/dd-li}} | ||
</ul> | ||
</li> | ||
{{/dropdown}} | ||
{{/items}} | ||
</ul> |
6 changes: 6 additions & 0 deletions
6
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/logo.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<a class="brand" href="{{_rel}}index.html"> | ||
<img src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" class="logomark"> | ||
<span class="brand-title">{{_appName}}</span> | ||
</a> |
13 changes: 13 additions & 0 deletions
13
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/namespace.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1> | ||
<div class="markdown level0 summary">{{{summary}}}</div> | ||
<div class="markdown level0 conceptual">{{{conceptual}}}</div> | ||
<div class="markdown level0 remarks">{{{remarks}}}</div> | ||
{{#children}} | ||
<h3 id="{{id}}">{{>partials/namespaceSubtitle}}</h3> | ||
{{#children}} | ||
<h5><xref uid="{{uid}}" altProperty="fullName" displayProperty="name"/></h5> | ||
<section>{{{summary}}}</section> | ||
{{/children}} | ||
{{/children}} |
19 changes: 19 additions & 0 deletions
19
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/navbar.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<div> | ||
<div class="mobile-hide"> | ||
{{>partials/logo}} | ||
</div> | ||
|
||
{{#_enableSearch}} | ||
<div class="sidesearch"> | ||
<form id="search" role="search" class="search"> | ||
<i class="bi bi-search search-icon"></i> | ||
<input type="text" id="search-query" placeholder="{{__global.search}}" autocomplete="off"> | ||
</form> | ||
</div> | ||
{{/_enableSearch}} | ||
|
||
<div id="navbar"> | ||
</div> | ||
</div> |
13 changes: 13 additions & 0 deletions
13
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/scripts.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<script src="https://code.jquery.com/jquery-3.6.3.min.js" integrity="sha256-pvPw+upLPUjgMXY0G+8O0xUf+/Im1MZjXxxgOcBQBXU=" crossorigin="anonymous"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-+sLIOodYLS7CIrQpBjl+C7nPvqq+FbNUBDunl/OZv93DB7Ln/533i8e/mZXLi/P+" crossorigin="anonymous"></script> | ||
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script> | ||
<script type="text/javascript" src="{{_rel}}styles/jquery.twbsPagination.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/jquery.mark.min.js"></script> | ||
<script type="text/javascript" src="{{_rel}}styles/url.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/anchor.min.js"></script> | ||
<script type="text/javascript" src="{{_rel}}styles/docfx.js"></script> | ||
<script type="text/javascript" src="{{_rel}}styles/main.js"></script> | ||
<script type="text/javascript" src="{{_rel}}styles/singulink.js"></script> |
9 changes: 9 additions & 0 deletions
9
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/searchResults.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<div id="search-results" style="display: none;"> | ||
<h1 class="search-list">{{__global.searchResults}} <span></span></h1> | ||
<div class="sr-items"> | ||
<p><i class="bi bi-hourglass-split index-loading"></i></p> | ||
</div> | ||
<ul id="pagination" data-first={{__global.pageFirst}} data-prev={{__global.pagePrev}} data-next={{__global.pageNext}} data-last={{__global.pageLast}}></ul> | ||
</div> |
5 changes: 5 additions & 0 deletions
5
Docs/templates/SingulinkFX-3.0.2/singulinkfx/partials/toc.tmpl.partial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} | ||
|
||
<div id="sidetoggle"> | ||
<div id="sidetoc"></div> | ||
</div> |
Oops, something went wrong.