Gradus is an open-source tool that enables you to create codelabs using both markdown and rich markdown components. It offers the flexibility to operate either server-side or client-side, depending on your preference. Additionally, Gradus is experimenting with AI-enabled features to enhance its capabilities.
- Gradus is user-friendly, allowing you to effortlessly create codelabs with markdown and its rich components.
- Features a mobile-friendly user interface.
- SEO-optimized to ensure all content is indexed, boosting visibility in search results.
- Equipped with experimental AI-enabled functionalities.
- Suitable for both individual developers and tech communities.
- Fast and optimized for performance.
Ensure you have the following installed:
- Node.js (version 18 or later)
- NUXT 3 (a modern Vue.js framework)
- Vuetify 3 (a Vue UI Library)
Important
Note on AI Features: Currently, AI features are only supported in SSR deployments.
Awesome! We greatly appreciate contributions of all kinds. To make the process smoother, here are some guidelines that should help you get started quickly.
- What to Use Issues For: Feel free to use GitHub issues for questions, bug reports, and feature requests.
- Searching: Before creating a new issue, use the search feature to check if there is already an existing discussion about it.
- Information and Resources: Include as much information as possible when creating an issue. Relevant resources like screenshots are very helpful.
- Bug Reports: For bug reports, ensure you provide a reproducible test case. A pull request with a failing test is ideal, though not required.
- Commit Management: Squash your commits to keep the history clean.
- Code Quality: Lint your code with eslint, using the provided configuration, to maintain code quality.
- Tests: Include updates or additions to tests relevant to your changes.
- Branch Policy: Make pull requests against the
dev-contributionbranch. Pull requests to other branches will be rejected unless specified by the maintainers.
You can highlight your project in the readme.md file and also fill out the provided Google form to share more about what you’ve built.
If you encounter any issues or have queries, post them in the issues section. Our dedicated team will strive to address your concerns within 10-12 hours.
