#Publish to the marketplace

Publishing your own plugin or lint rule to the marketplace is straightforward, as the only thing you have to add to our item registry is the URL of your marketplace-manifest.json.



#1. Add the information to your marketplace manifest

Adding the marketplace information is necessary for the marketplace to display your item correctly. You can use these category-specific templates:

#Official JSON schema

You can ensure that your manifest is valid by loading the following schema.

"$schema": "https://inlang.com/schema/marketplace-manifest"

#Naming your item

idThe unique identifier should always be written in camelCase like this: camelCase.camelCase.camelCase
displayNamePlease follow the Apple Style Guide and write the first letter of a new word in the title always in uppercase, e.g. Language Tag. Rule of thumb: The first letter of the first word always has to be uppercase, except your displayName is a name written in lowercase letters everywhere else like npm for example.
descriptionPlease make sure to describe your item as simple as possible. It is best practice to write 100 to 200 characters.
readmeThe readme acts as documentation for your item and is written in markdown. Feel free to use github flavored markdown, additionally you use inlang's custom web components (doc-elements).
keywordsKeywords are always written in lowercase e.g. i18n, adoptable

#2. Writing your readme

# Please note

It is completely up to you how you want to style your product pages. This is just an inspiration for you to get started.

#How we at inlang style product pages

We are using an engaging header image with up to three key features of the product. If it is important to the product, we introduce a Getting started section beforehand.

How we style product pages at inlang

Of course styling product pages can change from time to time. If you have any questions regarding this, please reach out to us on Discord.

Please note that you need to include a key of a 8 character long random string. You can generate one here. Allowed are numbers and lowercase letters. This key is necessary for the marketplace to identify your item.

If you are publishing an app, plugin or lint rule, you can add your product to the "m" category.

Add the raw link of your manifest to this file. You can fork the repository to do so.

#4. Create a pull request and wait for approval

Create a pull request with your changes and wait for approval from our team. Usually, this will take less than 24 hours. After that, your item will be available in the marketplace.

Feel free to join our Discord if you have any questions or need help with publishing your item.

#Markdown assets

#inlang ecosystem compatible badge

Please use this badge in your README.md to show the your contributor that your software is inlang ecosystem compatible.



#Custom web components


The <doc-figure> element is used to display images in the readme. It is a wrapper around the <figure> element and has the same attributes.


  • src (required): The source to the image file.
  • alt (required): Alternative text for screen readers.
  • caption (required): Caption shown below the image.
<doc-figure src="https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/documentation/sdk/assets/ecosystem.jpg" alt="inlang ecosystem" caption="The inlang ecosystem"></doc-figure>


The <doc-icon> element is used to display icons in the readme.


  • icon (required): Iconify icon tag.
  • size (required): The size of the icon.
<doc-icon icon="mdi:github" size="1.5em"></doc-icon>

The <doc-link> element is used to display links in a more converting way inside of the readme.


  • title (required): The title for the document link.
  • icon (required): Iconify icon tag.
  • href (required): The link behind the document link.
  • description (required): The description shown in the quick link.
<doc-link title="Documentation" icon="mdi:book-open-page-variant" href="https://inlang.com/documentation" description="Read the documentation"></doc-link>


The <doc-slider> element is used to display a slider with images in the readme. As arrays are not supported in markdown, you have to separate the images with a comma.


  • items (required): The images being shown in the slider.
  • looping (optional): True if you want the slider to loop.
<doc-slider items="https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/documentation/sdk/assets/ecosystem.jpg, https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/documentation/sdk/assets/ecosystem.jpg, https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/documentation/sdk/assets/ecosystem.jpg"></doc-slider>


The <doc-feature> element is used to display a feature in the readme.


  • title (required): The title of the feature.
  • icon (optional): Show an icon from Iconify.
  • image (optional): Show an image (you can only show an image or an icon).
  • color (optional): The background color of the feature.
  • text-color (optional): The text color of the feature.
<doc-feature title="Feature" icon="mdi:github" color="#E5E8EB"></doc-feature>


The <doc-accordion> element is used to display content in an expandable accordion, which is useful e.g. for FAQs.


  • heading (required): The heading of the accordion.
  • text (required): The content of the accordion.
<doc-accordion heading="Question" text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, diam quis aliquam ultricies, nisl nunc ultricies nunc, vitae ultrices nisl nunc eu nunc."></doc-accordion>

Was this helpful?

Thank you for your feedback ♥️