Professional documentation for Trivule, a user-friendly JavaScript library for HTML form validation.
View Online • GitHub • Contributing
Trivule is a user-friendly JavaScript library for HTML form validation. It allows you to quickly add validation rules to your form fields using custom HTML attributes, without the need to write additional JavaScript code. Trivule's custom HTML attributes are easy to understand and use, enabling you to quickly set up a robust validation system without spending a lot of time creating custom validation functions or writing complex JavaScript code.
This documentation site is built with Next.js and Fumadocs, providing a seamless experience for developers and contributors.
- Node.js (version 18 or higher)
- pnpm (only package manager supported; others will be rejected)
Clone the repository:
git clone https://github.com/jsbenin/trivule-docs.git
cd trivule-docsInstall dependencies:
pnpm installRun the development server:
pnpm devOpen http://localhost:3000 with your browser to see the result.
| Route | Description |
|---|---|
app/(home) |
The route group for your landing page and other pages. |
app/docs |
The documentation layout and pages. |
app/api/search/route.ts |
The Route Handler for search. |
Key files:
lib/source.ts: Content source adapter using Fumadocs API.lib/layout.shared.tsx: Shared layout options.source.config.ts: Configuration for MDX and frontmatter.
We welcome contributions! Please see our Contributing Guide for details on how to get started.
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature - Make your changes
- Run tests and linting:
pnpm lint - Commit your changes:
git commit -m "Add your message" - Push to your branch:
git push origin feature/your-feature - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.