Skip to content

simple-jwt-login/website

Repository files navigation

Simple JWT Login Documentation

CI-validate CI-deploy pages-build-deployment

This is the official documentation repository for the Simple JWT Login WordPress plugin!

This project uses Docusaurus to provide a structured and easy-to-navigate documentation site.

About Simple JWT Login

Simple JWT Login is a WordPress plugin designed to allow easy authentication via JSON Web Tokens (JWT). This plugin provides a secure way to manage API access by generating and verifying tokens, making it ideal for custom WordPress API integrations and user authentication.

Getting Started

This repository includes everything needed to contribute to or run the documentation locally. Please follow the steps below to set up the project.

Prerequisites

Running the Project Locally

docker-compose up

Access the website at http://localhost:3002

Project Structure

The project is structured as follows:

  • /docs: Contains markdown files for the main documentation content.
  • /blog: Stores any blog content for the documentation site.
  • /releases: Stores any releases content for the documentation site.
  • /src: Holds custom components and styling files.
  • docusaurus.config.js: Main configuration file for the Docusaurus site.
  • sidebars.js: Defines the structure and sidebar items for the documentation.

Contributing

We welcome contributions to improve and expand the documentation! Here’s how you can get involved:

  1. Fork the repository.
  2. Create a branch for your feature or fix.
  3. Commit your changes with a clear message.
  4. Push your branch and create a Pull Request.

:tip Please ensure your changes follow the structure and style guidelines of the existing documentation.

License

This project is licensed under the MIT License.