2021-01-31 22:35:58 +02:00
2021-01-31 22:35:58 +02:00
2021-01-31 23:14:59 +02:00
2021-06-13 21:51:03 +03:00
2021-01-31 22:35:58 +02:00
2021-01-31 22:35:58 +02:00
2021-01-31 23:16:49 +02:00
2021-01-31 22:35:58 +02:00

BepInEx DocFx template

This template is still WIP
Do not use in production!

A template for new BepInEx documentation!

Template Preview

Features

This is a rewrite of the default DocFx template with emphasis on usage of HTML5/CSS3 instead of JavaScript for its functionality.

Most important differences from the default DocFx template (and most other templates available on the net):

  • Removed dependency on jQuery and Bootstrap
  • Uses TypeScript for scripts and Tailwind for styles
  • TOC is now generated statically instead of relying on JS
  • Layout made with CSS Grids for simplicty
  • Added dark mode switch

Editing the template

To edit the template, you need to npm install required tools.
This template depends on the following libraries/tools:

  • TypeScript -- used to build scripts and bundle them into a single file
  • Tailwind and PostScript -- used to build style file

All source files are in bepin_new/lib folder. When editing, keep in the following in mind:

  • Avoid using Tailwind classes in HTML. Instead, use @apply rule in .css files to apply styles to elements to reduce the amount of final CSS styles emitted.
  • Do not use Font Awesome or other icon libraries directly. Instead, use Fontello to bundle only required icons.

To build the template styles and scripts, run npm run build_prod.

S
Description
Template for BepInEx Docs website
Readme
3.9 MiB
0 Stars 1 Watchers 0 Forks
Languages
TypeScript 47.1%
CSS 39.8%
JavaScript 10.5%
Go Template 2.6%