Sorry if this has been asked, I tried searching for documentations but all I can find is the Get Started post, it helped me create a plugin but it didn’t cover topics such as what APIs are available. So, are there documents at all?
Thanks!
The discussion centers on the lack of comprehensive documentation for Discourse’s Plugin API. a9udn9u initially asks for API docs beyond the basic Get Started guide, noting that existing resources like docs.discourse.org and the Beginner’s Guide don’t explain plugin-specific properties, callbacks, or method parameters like those in Chrome or WordPress plugin docs. net_deamon suggests consulting Ember and Rails docs or browsing Discourse’s source code, referencing a prior thread for context. erlend_sh encourages such questions to be posted in Development. bcartwri96 bumps the thread for visibility. pacharanero confirms the scarcity of official Plugin API docs, noting that while some conventions are Ember/Rails-based, much is unique to Discourse. They suggest community collaboration to build a Discourse Developer Manual, pointing to early efforts at thepavilion.io. fzngagan and alxndr direct users to the plugin-api.gjs file in the Discourse repo, which contains brief inline documentation for available methods — now located at blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs. The consensus is that developers must currently rely on source code, community posts, and fragmented guides.
Sorry if this has been asked, I tried searching for documentations but all I can find is the Get Started post, it helped me create a plugin but it didn’t cover topics such as what APIs are available. So, are there documents at all?
Thanks!
Api documentation is available at
Discourse API doc is not what I’m requesting. I was thinking about something like Chrome plugin development docs or WordPress plugin development docs. For example when I read the Beginner’s Guide to Creating Discourse Plugins, I have questions like what are other special properties and callbacks does Discourse recognize in the default module? or what parameters are passed into the initialize() method? Neither the guide nor docs.discourse.org answered those questions.
As discourse uses ember in frontend and rails in backend, you can browse their respective docs to know how to create components, or controllers, etc.
That being said, you can go through the code of discourse to learn how they are doing things.
I had asked similar question long time back… See if the answers given here help you.
Then those questions are probably good candidates for Development ![]()
Поднимаю эту тему, так как на неё не ответили ![]()
@bcartwri96 Я считаю, что суть в том, что для API плагинов Discourse практически отсутствует исчерпывающая документация.
На Meta есть разрозненная информация, например, Developing Discourse Plugins - Part 1 - Create a basic plugin, но, похоже, нет полного справочника по API. Хотя часть того, что происходит, является стандартным Ember или Rails, существует огромный пласт специфики, который представляет собой чистые соглашения Discourse.
Со временем было бы здорово, если бы сообщество взялось за создание Руководства разработчика Discourse, которое заполнило бы этот пробел. Мы уже начали это делать в виде фрагментов инструкций HOWTO по адресу Pavilion, и, надеюсь, эта работа послужит начальным фундаментом для разработки более полного справочного руководства.
Посмотрите этот файл. Большинство методов кратко задокументированы
https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/app/lib/plugin-api.js
Этот файл перемещён в blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs