https://github.com/hyblocker/hekky-shader-docs

An SSG based documentation system which explains how to use Hekky's Shaders
https://github.com/hyblocker/hekky-shader-docs

documentation documentation-generator documentation-site pbr shaders unity3d vrchat

Last synced: 21 days ago
JSON representation

An SSG based documentation system which explains how to use Hekky's Shaders

• Host: GitHub
• URL: https://github.com/hyblocker/hekky-shader-docs
• Owner: hyblocker
• License: other
• Created: 2022-03-25T16:12:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T01:33:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-27T18:53:56.945Z (3 months ago)
• Topics: documentation, documentation-generator, documentation-site, pbr, shaders, unity3d, vrchat
• Language: JavaScript
• Homepage: https://docs.hyblocker.dev/en
• Size: 70.2 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hekky Shader Documentation

> You probably meant to go to [https://docs.hyblocker.dev/en/](https://docs.hyblocker.dev/en/)

This repository contains the documentation for Hekky's Shaders.

## Contributing

If you wish to translate the documentation to another language or clarify some text in the docs, please either DM me on Discord (you may find me on the support server, see the documentation for the invite), create an issue or file a PR.

## Tech

The documentation uses an entirely custom template on top of Astro, with a few supporting libraries.

### Motivation

I wrote my own documentation generator as I wasn't satisfied with the current solutions. I wanted a good, lightweight documentation generator that had you focus mostly on writing documentation, which doesn't require Javascript. Javascript is used solely to enhance the experience (for example by adding a search function or a swipe to show sidebar function on mobile devices, or to provide WebGL based diagrams to allow the user to better understand a concept by being able to see how certain properties affect the look of a shader).

## License

This website is licensed under a Creative Commons Attribution-NonCommercial-ShareALike license. See [the LICENSE file](https://github.com/hyblocker/hekky-shader-docs/blob/master/LICENSE) for more information.

![CC-BY-NC-SA](https://i.creativecommons.org/l/by-nc/4.0/88x31.png)

The SSG template I created for this may later be released under a different license.