0.04
Low commit activity in last 3 years
CLI helper for creating Discourse themes
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

~> 2.0
~> 2.14
~> 5.0
~> 13.0
>= 0
~> 3.17

Runtime

~> 3.1
~> 0.6
~> 1.2
~> 0.18
 Project Readme

Discourse Theme

This CLI contains helpers for creating Discourse themes and theme components.

Installation

To install the CLI use:

$ gem install discourse_theme

Why this gem exists?

This gem allows you to use your editor of choice when developing Discourse themes and theme components. As you save files the CLI will update the remote theme or component and changes to it will appear live!

Usage

For help run:

discourse_theme

discourse_theme new PATH

Creates a new blank theme. The CLI will guide you through the process.

discourse_theme download PATH

Downloads a theme from the server and stores in the designated directory.

discourse_theme watch PATH

Monitors a theme or component for changes. When changed the program will synchronize the theme or component to your Discourse of choice.

discourse_theme upload PATH

Uploads a theme to the server. Requires the theme to have been previously synchronized via watch.

Contributing

Bug reports and pull requests are welcome at Meta Discourse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the DiscourseTheme project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.