Skip to content

Commit

Permalink
Update for docfx 2.62.1+
Browse files Browse the repository at this point in the history
  • Loading branch information
mikernet committed Feb 25, 2023
1 parent 7d3a7a1 commit 9acc277
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 125 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
- Easily configurable colors and side bar 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 `memberpage`.
- Optional `memberpage-extras` plugin that improves wrapping behavior of long member names in the table of contents and puts explicit interface implementations into their own section to reduce clutter in the other sections, just like Microsoft's .NET documentation.
- Contains optional style overrides optimized for displaying articles.
- Includes [Bootstrap Icons](https://icons.getbootstrap.com/).

Expand All @@ -26,16 +25,26 @@ Visit https://github.com/Singulink to see our full list of publicly available li
## 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 new directory named `templates`, if it doesn't already exist.
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. (Optional) [Download the memberpage plugin](https://dotnet.github.io/docfx/templates-and-plugins/plugins-dashboard.html) and follow instructions, place it into a `plugins` folder
5. (Optional) Copy the `memberpage-extras` folder from this repository into the `plugins` folder
6. In your `docfx.json` configuration file, add the `singulinkfx`, `memberpage` and `memberpage-extras` path into the `build.template` property:
4. In your `docfx.json` configuration file, add the `singulinkfx` path into the `build.template` property:
```json
"template": ["default", "templates/singulinkfx", "plugins/memberpage.2.59.0/content", "plugins/memberpage-extras"]
"template": ["default", "templates/singulinkfx"]
```

A real-world example of a .NET library using this template with articles, `memberpage` and `memberpage-extras` 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.
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 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

Expand Down Expand Up @@ -73,10 +82,6 @@ Wrap your HTML or markdown in a `<div class="article"></div>` to activate styles

## More Screenshots

### Memberpage-Extras

![Memberpage-Extras Screenshot](./screenshots/memberpage-extras.png)

### Desktop

![Article Screenshot](./screenshots/article.png)
Expand Down
33 changes: 0 additions & 33 deletions memberpage-extras/ManagedReference.extension.js

This file was deleted.

79 changes: 0 additions & 79 deletions memberpage-extras/toc.html.js

This file was deleted.

2 changes: 1 addition & 1 deletion singulinkfx/partials/scripts.tmpl.partial
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></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.js"></script>
<script type="text/javascript" src="{{_rel}}styles/url.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
Expand Down
1 change: 0 additions & 1 deletion singulinkfx/styles/discord.css
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,6 @@ li.in > ul
ul.level2 > li > a.sidebar-item,
ul.level3 > li > a.sidebar-item
{
font-weight: 500;
font-size: .95em;
padding: 0;
margin: 2px 16px;
Expand Down

0 comments on commit 9acc277

Please sign in to comment.