Skip to content

hackutd/docs

Repository files navigation

HackUTD Docs

The centralized documentation for HackUTD's open source projects, built with Mintlify and served at docs.hackutd.co.

Repository structure

Path Description
docs.json Site config: navigation, theme colors, logos, navbar, footer.
index.mdx Landing page (intro + project cards).
jury.mdx, harp.mdx, technical-documentation.mdx Project pages.
style.css Brand theme: HackUTD gradient, Satoshi font, buttons. Auto-loaded by Mintlify.
logo/ light.svg (dark wordmark) and dark.svg (white wordmark).
favicon.svg Black HackUTD mark.

Local development

Install the Mintlify CLI:

npm i -g mint

Run from the repo root (where docs.json lives):

mint dev

Preview at http://localhost:3000. Check for broken links with mint broken-links.

Branding

The HackUTD look is defined in docs.json (brand colors, light/dark logos, light mode default) and style.css (the brand gradient background, the Satoshi font via Fontshare, and button styles). The site defaults to light mode.

Deployment

Pushing to main triggers Mintlify's auto-deploy (via the Mintlify GitHub app). The site is served at docs.hackutd.co.

Contributing

Pages are MDX files with YAML frontmatter. Configuration lives in docs.json. See AGENTS.md for style preferences (active voice, sentence-case headings, concise sentences).

Resources

About

Centralized HackUTD Docs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Generated from mintlify/starter