Skip to content

Instantly share code, notes, and snippets.

@JelteMX
Last active January 11, 2019 12:00
Show Gist options
  • Select an option

  • Save JelteMX/2c06a68b26654a5f8d802b89d033403a to your computer and use it in GitHub Desktop.

Select an option

Save JelteMX/2c06a68b26654a5f8d802b89d033403a to your computer and use it in GitHub Desktop.
Error in user YAML: (<unknown>): did not find expected key while parsing a block mapping at line 1 column 1
---
title: "Enter the title of the document"
category: "Enter the category under which the document should be published (for example, "Mobile"); if there is a parent, remove this category line"
parent: "Enter the parent document filename of this document if necessary (for example, "design-the-architecture"); if there is a category, remove this parent line"
menu_order: Enter the position of the document in the category or under the parent; number by 10 (for first), 20, 30, etc. for easy ordering of other documents in the future if necessary; don't add brackets or quotation marks; if no number is added, the system will add an extremely high number to order the documents, which means that if you only want a document to appear at the top, you only have to add "10" to that specific document, you don't have to order all the other documents in the category/under the parent
description: "Set a description with a maximum of 140 characters; this should describe what the goal of the document is, and it can be different from the document introduction; this is optional, and it can be removed"
tags: [Add a maximum of 5-7 tags/keywords; keep them focused on the most important topics of the document, and make sure the tag is used as a word in the actual content (will function best for SEO as a word in a heading); each tag should have quotation marks and be separated by a comma, for example: "Samba", "MxCloud", "cloud", "share"; the tags should be enclosed with brackets and quotation marks]
---

1 Title

Content

1.1 Subcontent

2 Title

Content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment