godotengine/discourse-theme
1
0
Fork 0
mirror of https://github.com/godotengine/discourse-theme.git synced 2025-12-31 17:48:45 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4c14122b35d5bc6dc2b48efef61076575f5756d3
discourse-theme/README.md
Winston 4c14122b35 Add warning about synchronizing live website
2023-11-15 18:28:47 +01:00

1.7 KiB
Raw Blame History

Discourse Theme

A Godot styled theme for discourse.

Development

You can use the discourse theme CLI to automatically push changes to a live website. Please follow the instructions in the official CLI documentation.

⚠️ Note: Please only sync to the theme creator website, not to the public Godot forum.

Once the CLI is installed, follow these steps as a one time setup:

  1. Go to discourse.theme-creator.io/my/themes
  2. Select "Install" > "From a git repository" and enter https://github.com/godotengine/discourse-theme
  3. Select "Advanced" and then "Edit Locally"
  4. Generate and copy an API key (store it somewhere!)

You can now see a live preview every time you want to work on the theme:

  1. On your local machine: open a terminal, navigate to the repository root directory and enter discourse_theme watch .
  • if asked, enter the root url: https://discourse.theme-creator.io/
  • if asked, enter the API key you retrieved in the one time setup
  • you may answer y to store these, so that you don't need to enter them again
  • select the theme "Godot" for synchronisation
  1. Go to discourse.theme-creator.io/my/themes and select the theme you are editing
  2. Click on the "Preview" button

Usage

Installation

  1. In discourse, go to Admin > Customize > Themes
  2. click the Install button and choose "From a git repository"
  3. Enter the URL of this repo: https://github.com/godotengine/discourse-theme

Updates

  1. In discourse, go to Admin > Customize > Themes
  2. Select the "Godot Theme"
  3. Click "Check for Updates"