The example is not supposed to be a full list of all possible arguments to the function, but rather close to something you would realistically write.

The documentation exists for a more detailed description of the functions, including what they do and the arguments they accept.

ENG/ru

that's right, but this is just a README file, and I would like to see a clear structured example, but in your example there is a small gap in the lines, which looks sloppy.

As a beginner in programming, I would like everything in the README presentation file to be as simple and understandable as possible, because that's exactly what it was created for, to introduce everyone who is interested in your project, regardless of their skill level.

in my example, you can delete elements 2 through 5 and replace them with dots if brevity and conciseness are important to you.

sorry to be rude, I don't speak English and I write through a translator.

eng/RU (original)

все верно, но это всего лишь файл README, и хотел бы увидеть наглядный структурированный пример, а в вашем примере есть небольшой разрыв в строчках, что выглядит неаккуратно.

как новичок в программировании, я бы хотел, чтобы все в файле презентации README было максимально простым и понятным, потому что именно для этого он и был создан, чтобы познакомить всех, кто заинтересован в вашем проекте не смотря на уровень навыков.

в моем примере вы можете удалить элементы со 2 по 5 и заменить их точками, если вам важна краткость и лаконичность.

извините, если грубо, я не владею английским и пишу через переводчик.

or:

let markdownBuilder = engine.markdown.createBuilder();

markdownBuilder.createHeading(1, 'Test Heading lvl 1');
markdownBuilder.createHeading(2, 'Test Heading lvl 2');
markdownBuilder.createHeading(3, 'Test Heading lvl 3');
markdownBuilder.createParagraph('This is a test paragraph.');
markdownBuilder.createParagraph('This is another test paragraph.');

return markdownBuilder;

Output

Test Heading lvl 1

Test Heading lvl 2

Test Heading lvl 3

This is a test paragraph.

This is another test paragraph.

or 2:

let markdownBuilder = engine.markdown.createBuilder();

markdownBuilder.createHeading(1, 'Test Heading lvl 1');
markdownBuilder.createHeading(6, 'Test Heading lvl 6');
markdownBuilder.createParagraph('This is a test paragraph.');
markdownBuilder.createParagraph('This is another test paragraph.');

return markdownBuilder;

Output

Test Heading lvl 1

Test Heading lvl 6

This is a test paragraph.

This is another test paragraph.

It looks neat too