index

Documentation about extending Discourse with plugins, themes, and theme components, working with the core code, and using the Discourse API.

这篇文档对你有帮助吗？

想留言或继续讨论？请到 Cyberforums 赛博论坛参与。参与讨论 / 回复

Discourse Developer Docs

index

Introduction to Discourse Development

Developing Discourse using a Dev Container

Developing Discourse on GitHub Codespaces

Install Discourse for development using Docker

Install Discourse on macOS for development

Install Discourse on Ubuntu or Debian for Development

Install Discourse on Windows for development

Install plugins in your non-Docker development environment

Set up a local Discourse Development Environment?

Set up a multisite development environment

Set up Discourse for development on Fedora Linux

Add Ember Components to Discourse

The UI kit of shared Discourse components, helpers, and modifiers

Automatically lint and format code before commits

Write acceptance tests and component tests for Ember code in Discourse

How to run Discourse core, plugin and theme QUnit test suites

Pinning plugin and theme versions for older Discourse installs (d-compat branches)

Ember object ownership (getOwner, service injections, etc.)

Using Google's 'tachometer' to measure JS performance changes in Discourse

Setup Continuous Integration using GitHub Actions

Developer's guide to Markdown extensions

Converting modals from legacy controllers to new DModal component API

Using the DModal API to render Modal windows (aka popups/dialogs) in Discourse

Using the JS API

Using Plugin Outlet Connectors from a Theme or Plugin

Using modifyClass to change core behavior

Creating Routes in Discourse and Showing Data

Adding a new 'managed' authentication method to Discourse

Preventing accidental serialization of ActiveRecord models

(not recommended) Overriding Discourse templates from a Theme or Plugin

Overview

Write end-to-end system specs for the Discourse user interface

Discourse toolkit to render forms.

AppEvents Triggers Reference

Using Transformers to customize client-side values and behavior

Customizing the topic list

Guidelines for CSS classes using BEM

JavaScript type hinting & validation (typescript)

Designing for Different Devices (Touch & Hover)

Designing for Responsive Widths (Breakpoints, Viewport & Containers)

Drag, resize, and gesture primitives

Bundle splitting for plugins

Private modules and the `-internals` convention

Developing Discourse Plugins - Part 1 - Create a basic plugin

Developing Discourse Plugins - Part 2 - Connect to a plugin outlet

Developing Discourse Plugins - Part 3 - Add custom site settings

Developing Discourse Plugins - Part 4 - Setup git

Developing Discourse Plugins - Part 5 - Add an admin interface

Developing Discourse Plugins - Part 6 - Add acceptance tests

Developing Discourse Plugins - Part 7 - Publish your plugin

Add a new locale from plugin

Add a new provider to discourse-chat-integration

Repackaging a markdown-it extension as a Discourse plugin

Structuring a plugin for Rails autoloading

Developing Discourse Themes & Theme Components

Theme Developer Quick Reference Guide

Designer's Guide to getting started with themes in Discourse

Get started with Theme Creator and the Theme CLI

Install the Discourse Theme CLI console app to help you build themes

Structure of themes and theme components

Split up theme Javascript into multiple files

Split up theme SCSS into multiple files

Add settings to your Discourse theme

Objects type for theme setting

Migrate Discourse theme settings

Adding metadata and screenshots to a Theme

Use Discourse Core Variables in your Theme

Add localizable strings to themes and theme components

End-to-end system testing for themes and theme components

Minimizing Maintenance on Theme Customizations

Change font sizes in your themes

Include assets (e.g. images, fonts) in themes and components

Replace Discourse's default SVG icons with custom icons in a theme

Update themes and plugins to support automatic dark mode

Theme modifiers: A brief introduction

Insert text or images anywhere on your site using CSS pseudo-elements

Create and share a font theme component

Install a new language for Highlight.JS via a theme component