{"id":26295511,"url":"https://github.com/zynith-seo/zynith-wordpress-plugin","last_synced_at":"2025-05-09T00:45:56.132Z","repository":{"id":281254561,"uuid":"943446422","full_name":"Zynith-SEO/zynith-wordpress-plugin","owner":"Zynith-SEO","description":"The Zynith SEO WordPress plugin.","archived":false,"fork":false,"pushed_at":"2025-04-29T06:06:04.000Z","size":739,"stargazers_count":7,"open_issues_count":56,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-09T00:45:32.008Z","etag":null,"topics":["seo","wordpress","zynith"],"latest_commit_sha":null,"homepage":"https://zynith.app","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zynith-SEO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-05T18:08:08.000Z","updated_at":"2025-04-25T16:37:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"74209d75-071c-4ce9-b3c4-4c1d3fe2bfc7","html_url":"https://github.com/Zynith-SEO/zynith-wordpress-plugin","commit_stats":null,"previous_names":["zynith-seo/zynith-wordpress-plugin"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zynith-SEO%2Fzynith-wordpress-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zynith-SEO%2Fzynith-wordpress-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zynith-SEO%2Fzynith-wordpress-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zynith-SEO%2Fzynith-wordpress-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zynith-SEO","download_url":"https://codeload.github.com/Zynith-SEO/zynith-wordpress-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253171215,"owners_count":21865282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["seo","wordpress","zynith"],"created_at":"2025-03-15T04:14:16.331Z","updated_at":"2025-05-09T00:45:56.124Z","avatar_url":"https://github.com/Zynith-SEO.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n![image](_repo/zynith-seo-cover-image.png)\n\n# Zynith SEO Plugin\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp align=\"center\"\u003e\n   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.\n   \u003cbr /\u003e\n   \u003cbr /\u003e\n   \u003ca href=\"https://github.com/Zynith-SEO/zynith-wordpress-plugin/issues/new?assignees=\u0026labels=bug%2Cpending+triage\u0026projects=\u0026template=bug_report.yaml\"\u003eReport Bug\u003c/a\u003e\n   \u0026middot;\n   \u003ca href=\"https://github.com/Zynith-SEO/zynith-wordpress-plugin/issues/new?assignees=\u0026labels=enhancement%2Cpending+triage\u0026projects=\u0026template=feature_request.yaml\"\u003eFeature Request\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#build-logic\"\u003eBuild Logic\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003c!-- \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e --\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n### Built With\n\n- [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm)\n- [Node.js](https://nodejs.org/)\n- [Vite](https://vite.dev/)\n- [SASS/SCSS](https://sass-lang.com/)\n- [Gulp.js](https://gulpjs.com/)\n- [ESLint](https://eslint.org/)\n- [Prettier](https://prettier.io/)\n- [Warp Terminal](https://warp.dev)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nAll 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.\n\n### Prerequisites\n\nFor 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.\n\n- Switch to correct Node.js Version\n\n```zsh\nnvm use\n```\n\n### Installation\n\n1. Clone the repo.\n    ```sh\n    git clone https://github.com/Zynith-SEO/zynith-wordpress-plugin.git\n    ```\n2. Install NPM packages.\n    ```zsh\n    npm install\n    ```\n3. Run the start command to watch and build files.\n\n```zsh\nnpm run start:dev\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage\n\nBelow, you will find our common commands and notes for general usage.\n\n1. Run `npm run build:dev`.\n    - 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:\n        - Build the new plugin folder.\n        - Delete the current folder in your WP website.\n        - Copy your new plugin folder into the website's plugins folder.\n2. Run `npm run build:plugin`.\n\n    - When you build the plugin, the plugin folder **IS ZIPPED** and ready for upload to a WP website.\n\n3. Run `npm run start:dev`.\n\n    - 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.**\n    - A custom hot reload plugin is located in the Vite config file to watch all files in the `/src` folder.\n    - Each time a file is changed, the hot reload will trigger a `npm run build:dev`.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- BUILD PROCESS LOGIC --\u003e\n\n## Build Logic\n\n### Vite Build\n\nVite 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.\n\n### Build Plugin\n\nThis covers the series of tasks that are used to initially build the plugin folder. Found in both `build:dev` and `build:plugin` scripts.\n\n1. create-plugin-folders\n\n    - This will check to see if the folder `zynith-seo` exists. If not, this folder will be created.\n\n2. copy-php-to-plugin-folder\n\n    - This copies the `/src/php` folder over to `zynith-seo`.\n\n3. copy-assets-from-dist-to-plugin-folder\n\n    - This copies the `assets` folder from `dist/assets` over to `zynith-seo/assets`.\n\n\u003c!-- 4. copy-img-to-plugin-assets\n\n    - This copies the `img` folder from `src/assets/img` over to `zynith-seo/assets/img`. --\u003e\n\n4. copy-xsl-to-plugin-assets\n\n    - This copies the `*.xsl` file from `src/**/*` (which is where the sitemap file is located) over to `zynith-seo/assets`.\n\n5. convert-php-encoding\n\n    - With Vite, the PHP files don't get the correct file encoding. This step properly converts them to `utf-8` for WordPress.\n\n6. delete-empty-folders\n\n    - This will recursively delete all empty folders from the parent plugin folder `zynith-seo`.\n\n7. zip-plugin-core\n\n    - 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`.\n\n### Cleanup Plugin\n\nThis 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.\n\n1. delete-plugin-build-folders\n\n    - Delete the `/dist` folder that is generated by Vite.\n    - Delete the plugin folder (i.e., `/zynith-seo`).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\nWe 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).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf 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!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n\u003c!-- ## License\n\nDistributed under the MIT License. See `LICENSE.md` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e --\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\n## Acknowledgments\n\nWithout these people and tools, life would be too complicated.\n\n- Good food.\n- Good company.\n- Good tools.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/WPFedora/WordPress-Fedora.svg?style=for-the-badge\n[contributors-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/WPFedora/WordPress-Fedora.svg?style=for-the-badge\n[forks-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/network/members\n[stars-shield]: https://img.shields.io/github/stars/WPFedora/WordPress-Fedora.svg?style=for-the-badge\n[stars-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/stargazers\n[issues-shield]: https://img.shields.io/github/issues/WPFedora/WordPress-Fedora.svg?style=for-the-badge\n[issues-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/issues\n[license-shield]: https://img.shields.io/github/license/WPFedora/WordPress-Fedora.svg?style=for-the-badge\n[license-url]: https://github.com/Zynith-SEO/zynith-wordpress-plugin/blob/main/license.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzynith-seo%2Fzynith-wordpress-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzynith-seo%2Fzynith-wordpress-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzynith-seo%2Fzynith-wordpress-plugin/lists"}