@cresteem/richie-js NPM

Richie JS - Powerful SEO Tool for Generating Rich Results AKA Schema markups

Supported Platforms

Supported browsers

Table of Contents 📝

Features and Benefits ✨

Richie JS empowers developers with an efficient toolset for generating SEO-friendly structured data. Here's what makes Richie JS stand out:

Core Features:

Automated Rich Results Generation: Automatically generate structured data (JSON-LD) compliant with Google’s rich results standards.
Wide Schema Support: Supports multiple schema types like breadcrumbs, FAQs, and site search boxes to cater to diverse SEO needs.
Cross-Environment Compatibility: Works seamlessly in both Node.js and client-side environments, providing flexibility for all project types.
Lightweight and Optimized: Richie JS is designed to minimize dependencies and overhead, ensuring fast performance.
Configurable and Customizable: Define configurations with ease using richiejs.config.js, and leverage TypeScript types for intelligent support.
Intuitive CLI Application: Generate and deploy structured data through an easy-to-use Command Line Interface.

Latest Enhancements - Version 2.0.0:

Config File Enhancement: Migrated to richiejs.config.js for improved customization and better developer experience, including TypeScript IntelliSense support.
Expanded API Functionality: Richie JS API now supports handling an array of schemas, enabling advanced structured data strategies.
Performance Optimization: Removed dependencies (axios and mkdirp) and replaced them with built-in fetch and mkdirSync to save bytes and improve efficiency.
Enhanced CLI Features:
- New init command to create templates and auto-infer breadcrumb and site search box schema markup.
- Improved usability and optimizations for faster and seamless operation.
Linux Path Fixes: Resolved breadcrumb issues specific to Linux environments.
Richie.js Branding: Added an official Richie JS logo and a dedicated icon in VS Code for an enhanced developer experience.
Cross-Environment Compatibility Notice: Richie JS now fully supports both client-side and Node.js environments, making it versatile for a variety of use cases.
Browser-Side Note: While breadcrumb support is currently server-side only, other schema types work seamlessly in browser environments.

With its robust features, Richie JS simplifies the implementation of structured data, ensuring optimal SEO performance while providing a smooth development experience.

Use Cases ✅

SEO Specialists: Effortlessly generate rich snippets for client websites, improving search rankings.
Web Developers: Integrate structured data into websites without complex coding.
Digital Marketers: Enhance website visibility and drive engagement through optimized SEO practices.
Content Managers: Automatically generate SEO-friendly structured data for blog posts and articles.
E-commerce Platforms: Improve product visibility in search results by incorporating rich snippets.
Agencies and Freelancers: Quickly deliver SEO enhancements to client projects.

🙏🏻 Support Richie.js and Help It Grow

Every star on this repository is a symbol of encouragement and a testament to the value Richie.js brings to its users. If this tool has simplified your SEO efforts or improved your workflow, please consider showing your support by giving it a star ⭐ — it only takes a second!

But why stop there? If Richie.js has been especially useful in your projects, consider sponsoring the development to help us keep improving, innovating, and supporting the community.

💡 The "Star" button is at the top-right of the page, near the repository name.

Your support, whether through a star or sponsorship, fuels our passion and drives us to build even better tools for everyone. Thank you for being part of the journey! 🌟✨

Installation - Step-by-Step Guide 🪜

Refer below link:
Getting Started

Usage

Complete usage documentation is available here: Richie.js Documentation

Generate a rich result

rjs make

Store output in a specific directory

rjs make -d <destinationFolder>

Exclude specific files and folders

rjs make -o <relativePath/subpath>

⚙️🛠️ Custom Configuration

rjs init

Now you can configure your settings inside richiejs.config.js file.

License ©️

This project is licensed under the Apache License 2.0.

Contributing to Our Project 🤝

We’re always open to contributions and fixing issues—your help makes this project better for everyone.

If you encounter any errors or issues, please don’t hesitate to raise an issue.

Website 🌐

richiejs.cresteem.com

Contact Information

For any questions, please reach out via connect@cresteem.com

Credits 🙏🏻

Richie JS is an open-source project developed and maintained by DARSAN at CRESTEEM. Special thanks to the creators and maintainers of the foundational libraries.