Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 3.43 KB

README.md

File metadata and controls

51 lines (28 loc) · 3.43 KB
Raw

Newspack

semantic-release newspack-plugin

Welcome to the Newspack plugin repository on GitHub. Here you can browse the source, look at open issues and keep track of development. We also recommend everyone follow the Newspack blog to stay up to date about everything happening in the project.

The Newspack plugin provides tools and guidance for setting up and managing the important features and plugins a modern newsroom needs.

Newspack is an open-source publishing platform built on WordPress for small to medium sized news organizations. It is an “opinionated” platform that stakes out clear, best-practice positions on technology, design, and business practice for news publishers.

How to install Newspack on your site

If you'd like to install Newspack on your self-hosted site or want to try Newspack out, the easiest way to do so is to download the latest plugin release and the latest theme release. Upload them using the plugin or theme installer in your WordPress admin interface. To take full advantage of Newspack, the plugin and theme should be run together, but each should also work fine individually.

Reporting Security Issues

To disclose a security issue to our team, please submit a report via HackerOne here.

Contributing to Newspack

If you have a patch or have stumbled upon an issue with the Newspack plugin/theme, you can contribute this back to the code. Please read our contributor guidelines for more information on how you can do this.

Development

  • Run npm start to compile the SCSS and JS files, and start file watcher.
  • Run npm run build to perform a single compilation run.

Environment variables

Some features require environment variables to be set (e.g. in wp-config.php):

// Support
define( 'NEWSPACK_SUPPORT_EMAIL', '[email protected]' );

News Consumer Insights integration

News Consumer Insights is a Google Analytics based solution for measuring performance of site audience using benchmarks and getting actionable recommendations to improve business gaps.

This plugin reports NCI events to a Google Analytics account, if one is connected via the Site Kit plugin. We're working on supporting all applicable NCI events. The implementation is in includes/class-analytics.php file.

Support or Questions

This repository is not suitable for support or general questions about Newspack. Please only use our issue trackers for bug reports and feature requests, following the contribution guidelines.

Support requests in issues on this repository will be closed on sight.

License

Newspack is licensed under GNU General Public License v2 (or later).