Darkdown Clarification

Feature Discussion
1

Hi Team,

I hope you are all keeping well. I was wondering if I could ask some questions about Darkdown, the Developerhub version of Markdown. We want to automatically create and maintain a document through the API and would like to know a few things.

  1. Are Markdown and Darkdown effectively the same in most cases? I see there is a document here explaining how it differs from regular Markdown. https://docs.developerhub.io/support-center/importing-documentation#darkdown-format. Are the changes here the only ones we can expect?

  2. With regards to some components listed, what is the correct way of passing a component such as a table? I see we should use the ‘table’ block element, but I’m curious as to how the data of that block should be presented.

Thank you for your help in advance!

2

Hi @Diana_Donohue,

Hope you’re doing great! Here are the answers to your questions:

  1. Basically, all text is formatted using Markdown. All blocks/inline blocks are formatted using our Darkdown format. Page links are always relative.
  2. For tables, you can even pass it in as Markdown and it would be imported correctly. The format for a table must be as such:
| Browser | Mode | Is Supported? | Remarks | 
| ---- | ---- | ---- | ---- | 
| Chrome | Desktop | Yes | Fully supported | 
| Chrome | Mobile | Yes | Fully supported |

We’ve just updated our documentation, you can find more information about table format here: https://docs.developerhub.io/support-center/importing-documentation#table-format.

One more thing to add is: Ensure you have an empty line between blocks and text always.

Let me know if you have any further questions.

3

Thank you for the swift response and updated documentation around Darkdown, Zed. Much appreciated! This is very helpful. :slightly_smiling_face: