https://github.com/orels1/shaders.orels.sh
Documenation website for orels-Unity-Shaders
https://github.com/orels1/shaders.orels.sh
documentation shaders unity
Last synced: over 1 year ago
JSON representation
Documenation website for orels-Unity-Shaders
- Host: GitHub
- URL: https://github.com/orels1/shaders.orels.sh
- Owner: orels1
- License: other
- Created: 2022-04-17T14:55:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T04:00:43.000Z (over 1 year ago)
- Last Synced: 2025-02-24T05:19:08.201Z (over 1 year ago)
- Topics: documentation, shaders, unity
- Language: JavaScript
- Homepage: https://shaders.orels.sh
- Size: 42.5 MB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# shaders.orels.sh docs
This is the [ORL Shaders](https://shaders.orels.sh) documentation website.
It is built with Next.js using Tailwind UI "Syntax" theme as the base and customized to fit the style and requirements of the documentation.
This website is deployed to Vercel on branch push.
## Development
To get started with development, first, install the dependencies:
```bash
npm install
cp .env.example .env.local
```
Next, run the development server:
```bash
npm run dev
```
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
## License
This site's base template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license). It was customized beyond that to fit the style and requirements of the documentation.
Everything else on the docs is MIT. Check the [License](LICENSE) file for more details.
## Learn more
Some of the tech used to build the docs:
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Markdoc](https://markdoc.io) - the official Markdoc documentation
- [DocSearch](https://docsearch.algolia.com) - the official DocSearch documentation