This is the documentation website for the LogStruct gem, built with Next.js and shadcn/ui. It showcases the gem's features and provides comprehensive documentation for users.
- Interactive examples of LogStruct's JSON logging capabilities
- Comprehensive documentation of all gem features
- Mobile-responsive design with shadcn/ui components
- Dark mode support
- Node.js (version 18 or higher)
- pnpm (version 9 or higher)
- Install dependencies:
pnpm install- Start the development server:
pnpm dev- Open http://localhost:3001 to view the docs in your browser.
To build the static docs for production:
pnpm buildThis will generate static HTML files in the out directory that can be deployed to any static web hosting service.
This site is configured to deploy to GitHub Pages automatically through GitHub Ac 380A tions. Any changes pushed to the main branch will trigger a deployment.
To manually deploy:
- Build the docs:
pnpm build- The static files will be in the
outdirectory, which can be deployed to any static hosting service.
app/- The Next.js applicationapp/page.tsx- The homepageapp/docs/- Documentation pages
components/- Reusable React componentspublic/- Static assets (images, etc.)
To add or update documentation:
- Create or edit files in the
app/docsdirectory - Each page should be a React component that exports a default function
- For new sections, update the sidebar in
app/docs/layout.tsx