Aventyret / solarplexus

Wordpress Block that is useful when building news sites
GNU General Public License v2.0
6 stars 1 forks source link

Solarplexus

Solarplexus is a Wordpress plugin and developer tool to easily create Gutenberg blocks for creating dynamic and static lists of posts, pages and more.

Installation & usage

To use the latest version in a Wordpress project, simply head over to the šŸ“– online documentation šŸ“– and don't bother with the dev stuff below.

Plugin development instructions

  1. Clone the repo in the plugins folder of a local WP installation
  2. composer install
  3. nvm use
  4. yarn install
  5. yarn start
  6. Create a custom theme in your WP installation and follow the regular instructions on the Wiki on how to use the plugin.

Translations

  1. Run yarn start to create a non-minified build/index.js.
  2. Run yarn translate to update splx.pot and existing splx-{locale}.po files.
  3. Translate new strings in splx-{locale}.po. This can be done through Poedit or directly in the file.
  4. Run yarn translate:compile to update splx-{locale}.mo and json files.

More info in the WP docs

Plugin distribution instructions

The plugin is versioned in dist versions here on GitHub.

  1. Make sure you have wp-cli and the dist-archive package installed.
  2. Update the version according to semver in package.json, README.txt, and the main plugin entry file solarplexus.php. Commit the changes and push to github.
  3. yarn build
  4. wp dist-archive . A dist version without dev-only files will be created in the directory above.
  5. On Releases page, click Draft a new release, fill in new version, changes etc, and upload the zip.
  6. The ./docs of the release tag will be published automatically when a release is created.