Skip to content

orels1/shaders.orels.sh

Repository files navigation

shaders.orels.sh docs

This is the ORL Shaders 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:

npm install
cp .env.example .env.local

Next, run the development server:

npm run dev

Finally, open 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. It was customized beyond that to fit the style and requirements of the documentation.

Everything else on the docs is MIT. Check the License file for more details.

Learn more

Some of the tech used to build the docs:

  • Tailwind CSS - the official Tailwind CSS documentation
  • Next.js - the official Next.js documentation
  • Headless UI - the official Headless UI documentation
  • Markdoc - the official Markdoc documentation
  • DocSearch - the official DocSearch documentation