Customize docs plugin text link

Hyan · September 12, 2023, 3:53am

Hi Discourse community,
I enabled discourse-docs plugin and add it to top menu. By default, its link is for example, www.example.com/docs, how can I change it to something like www.example.com/my-docs?

Canapin · September 12, 2023, 9:32am

Hi Hyan

This is not possible. This URL part is hardcoded here:

github.com

discourse/discourse-docs/blob/main/plugin.rb#L24


      
          
          register_svg_icon "sort-alpha-down"
          register_svg_icon "sort-alpha-up"
          register_svg_icon "sort-numeric-up"
          register_svg_icon "sort-numeric-down"
          register_svg_icon "far-circle"
          
          load File.expand_path("lib/docs/engine.rb", __dir__)
          load File.expand_path("lib/docs/query.rb", __dir__)
          
          GlobalSetting.add_default :docs_path, "docs"
          
          module ::Docs
            PLUGIN_NAME = "discourse-docs"
          end
          
          after_initialize do
            require_dependency "search"
          
            if SiteSetting.docs_enabled
              if Search.respond_to? :advanced_filter

There’s no setting to change this.

Hyan · September 12, 2023, 1:44pm

Thanks, @Canapin. I do see there’re some sites which docs link customized. Maybe they modify the code somehow. Probably there’re reasons do not expose the config to admin dashboard.

Canapin · September 12, 2023, 1:46pm

Can you share them?

Hyan · September 13, 2023, 11:59pm

I got to know that the website customized by code changing. I thought only the line of code needs to change if I would try to do. Mark the answer as resolved.