Editor commands

For Docs, we make use of Hashnode’s markdown-powered editor, which is packed with features that make creating and managing content a seamless experience.
The editor we use for docs includes everything the blog editor has and more. In this guide, we will cover all the features that are exclusive to Hashnode docs and will help you write better and more effective documentation.

Tabs

The /tabs command in the editor lets you add multiple editor components in the same row, which is helpful for visualizing content in various formats. One example is a quickstart guide where you can use it to write code samples in multiple languages or frameworks.

Here’s how you can use it within the docs editor:

Type /tabs in the docs editor, and it will add a tab component as shown in the image below:
You can customize the tabs based on the content you want to add. You can use Hashnode editor commands within the tab component. Here's an example of how that might look:

Button CTA

A button CTA component encourages users to take a specific action, like downloading a file or signing up. In documentation, it helps guide users to important links or next steps, making it easier to find key resources.

You can add buttons in Hashnode docs using the /button command in the editor, and it also allows you to customize the button color in light and dark mode.

Here’s how you can add and customize buttons:

Accordion and Accordion group

An accordion helps you organize content by showing or hiding sections when clicked. It makes documents easier to read by letting readers open only the parts they need.

The /accordion command in the editor lets you add Accordian and Accordian group in the docs.

Here’s how:

Type /accordion on the docs editor.
You will receive options to add Accordion and Accordion group.
Select what you want to add. If you select an Accordion, this is how it will look in your docs, and you can expand or collapse it using the down arrow icon.

If you choose an Accordian group, here’s how the collapsed version would look like:

Note: Within the Accordion, you can use Hashnode editor features, which allows you to make customizations.

Cards and Card Group

Cards help you display related content, like text or images, in a clear and organized way. They can help break up information into smaller, easy-to-read sections, making it simple for readers to find what they need quickly.

Within the Hashnode editor, you can use the card and card group component with the /card command and add customizations like links and images that improve the experience in docs.

Here’s how you can use the Card component within docs: