https://github.com/zynith-seo/zynith-wordpress-plugin
The Zynith SEO WordPress plugin.
https://github.com/zynith-seo/zynith-wordpress-plugin
seo wordpress zynith
Last synced: about 1 year ago
JSON representation
The Zynith SEO WordPress plugin.
- Host: GitHub
- URL: https://github.com/zynith-seo/zynith-wordpress-plugin
- Owner: Zynith-SEO
- License: gpl-3.0
- Created: 2025-03-05T18:08:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-29T06:06:04.000Z (about 1 year ago)
- Last Synced: 2025-05-09T00:45:32.008Z (about 1 year ago)
- Topics: seo, wordpress, zynith
- Language: PHP
- Homepage: https://zynith.app
- Size: 722 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
# Zynith SEO Plugin
Zynith SEO is a powerful, performance-optimized WordPress SEO plugin, designed specifically for SEOs. Our community is dedicated to helping SEO professionals maximize their WordPress sites through Zynith SEO, and it's available built-in tools and utilities.
Report Bug
·
Feature Request
Table of Contents
## About The Project
### Built With
- [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm)
- [Node.js](https://nodejs.org/)
- [Vite](https://vite.dev/)
- [SASS/SCSS](https://sass-lang.com/)
- [Gulp.js](https://gulpjs.com/)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [Warp Terminal](https://warp.dev)
## Getting Started
All plugin files live inside of the `/src` folder. These are the instructions on setting up your project locally. To get a local copy up and running follow these simple steps.
### Prerequisites
For all of the awesome people using Node Version Manager (NVM) instead of Node.js, we have an `.nvmrc` file in the repo. For everyone else, please check this file to make sure that your Node.js version matches.
- Switch to correct Node.js Version
```zsh
nvm use
```
### Installation
1. Clone the repo.
```sh
git clone https://github.com/Zynith-SEO/zynith-wordpress-plugin.git
```
2. Install NPM packages.
```zsh
npm install
```
3. Run the start command to watch and build files.
```zsh
npm run start:dev
```
## Usage
Below, you will find our common commands and notes for general usage.
1. Run `npm run build:dev`.
- When you build in dev, the plugin folder **IS NOT ZIPPED**. This is for those situations where you're working with local instance of WordPress using XAMP, LAMP, MAMP, etc. or even the LocalWP tool (which we use). Those steps are:
- Build the new plugin folder.
- Delete the current folder in your WP website.
- Copy your new plugin folder into the website's plugins folder.
2. Run `npm run build:plugin`.
- When you build the plugin, the plugin folder **IS ZIPPED** and ready for upload to a WP website.
3. Run `npm run start:dev`.
- This is runs the default `vite` command. The terminal will tell you to open the browser to a `localhost` port. **We do not use the browser.**
- A custom hot reload plugin is located in the Vite config file to watch all files in the `/src` folder.
- Each time a file is changed, the hot reload will trigger a `npm run build:dev`.
## Build Logic
### Vite Build
Vite will convert all of your `.scss` to `.css`. These files, along with all `.js` files, will all be placed in a `/dist` folder, and will be minified.
### Build Plugin
This covers the series of tasks that are used to initially build the plugin folder. Found in both `build:dev` and `build:plugin` scripts.
1. create-plugin-folders
- This will check to see if the folder `zynith-seo` exists. If not, this folder will be created.
2. copy-php-to-plugin-folder
- This copies the `/src/php` folder over to `zynith-seo`.
3. copy-assets-from-dist-to-plugin-folder
- This copies the `assets` folder from `dist/assets` over to `zynith-seo/assets`.
4. copy-xsl-to-plugin-assets
- This copies the `*.xsl` file from `src/**/*` (which is where the sitemap file is located) over to `zynith-seo/assets`.
5. convert-php-encoding
- With Vite, the PHP files don't get the correct file encoding. This step properly converts them to `utf-8` for WordPress.
6. delete-empty-folders
- This will recursively delete all empty folders from the parent plugin folder `zynith-seo`.
7. zip-plugin-core
- This will zip up folder `zynith-seo` and name the new zip with the current version found in the `package.json` file, example `zynith-seo-10.4.18.zip`.
### Cleanup Plugin
This covers the series of tasks that are used to clean up the plugin folder after the zip file is created. Found in the `build:dev` and `build:plugin` scripts.
1. delete-plugin-build-folders
- Delete the `/dist` folder that is generated by Vite.
- Delete the plugin folder (i.e., `/zynith-seo`).
## Roadmap
We don't have a dedicated roadmap outside of Github. Simply check the [open issues](https://github.com/Zynith-SEO/zynith-wordpress-plugin/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Acknowledgments
Without these people and tools, life would be too complicated.
- Good food.
- Good company.
- Good tools.
[contributors-shield]: https://img.shields.io/github/contributors/WPFedora/WordPress-Fedora.svg?style=for-the-badge
[contributors-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/WPFedora/WordPress-Fedora.svg?style=for-the-badge
[forks-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/network/members
[stars-shield]: https://img.shields.io/github/stars/WPFedora/WordPress-Fedora.svg?style=for-the-badge
[stars-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/stargazers
[issues-shield]: https://img.shields.io/github/issues/WPFedora/WordPress-Fedora.svg?style=for-the-badge
[issues-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/issues
[license-shield]: https://img.shields.io/github/license/WPFedora/WordPress-Fedora.svg?style=for-the-badge
[license-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/blob/main/license.md