https://github.com/bepinex/bepinex-docs-template

Template for BepInEx Docs website
https://github.com/bepinex/bepinex-docs-template

Last synced: 6 days ago
JSON representation

Template for BepInEx Docs website

• Host: GitHub
• URL: https://github.com/bepinex/bepinex-docs-template
• Owner: BepInEx
• Created: 2021-01-31T20:38:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-13T20:59:20.000Z (almost 4 years ago)
• Last Synced: 2025-03-04T12:46:28.366Z (over 1 year ago)
• Language: TypeScript
• Size: 4.51 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# BepInEx DocFx template

> **This template is still WIP**  

> Do not use in production!

A template for new BepInEx documentation!

![Template Preview](./docfx_preview.gif)

## 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](https://www.typescriptlang.org/) for scripts and [Tailwind](https://tailwindcss.com/) 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](https://fontello.com/) to bundle only required icons.

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