Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 2.82 KB

README.md

File metadata and controls

37 lines (20 loc) · 2.82 KB
Raw

Newspack

Welcome to the Newspack theme 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 theme is a forward-looking news theme designed and developed to be highly customizable with the WordPress block editor.

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

The Newspack theme repository contains the Newspack parent theme in a subdirectory. This means you cannot git clone the theme directly to the wp-content/themes directory and have it work. The recommended approach is to git clone the repository to another location, and symlink the newspack-theme/newspack-theme directory -- the folder containing the actual theme -- to the wp-content/themes directory of your development website.

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

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).