Documenting the docs
This commit is contained in:
Luis Fernando Molina committed
1 parent
dd95904014
commit
402be4dc9c
10 files changed
+186
-2
No files matched your search
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "1",
|
||||
"type": "Docs Text Style",
|
||||
"definition": "The text style is the one used for content without any particular style applied.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When you edit a paragraph set in text style, anything you type will be rendered as part of the paragraph. What you can not do is to embed html within the text, because it will be discarded. By creating new paragraphs while editing, you effectively create separate paragraphs out of edit mode. Later you can change each paragraph's individual style for any of the styles available."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "This is a paragraph in text style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "2",
|
||||
"type": "Docs Title Style",
|
||||
"definition": "Use this style to render titles on the docs page.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "As the name suggests, the title style simply makes anything you type while editing visible as a title at the docs page."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The previous one is a paragraph in title style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "3",
|
||||
"type": "Docs Subtitle Style",
|
||||
"definition": "This is simply the way to show subtitles within a docs page.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In edit mode, type whatever you want to be rendered as a subtitle at the docs page."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The previous one is a paragraph in subtitle style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "4",
|
||||
"type": "Docs Note Style",
|
||||
"definition": "This style will render in a blue box with the word note as a prefix.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "While editing a paragraph of this style, simply type the text you would like to appear inside the box. The word note is added automatically."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": " This is an example of a paragraph in note style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "5",
|
||||
"type": "Docs Warning Style",
|
||||
"definition": "Use this style for boxing text as a warning to readers.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Anything you type while editing a paragraph of this style will be rendered inside the warning box."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Warning",
|
||||
"text": "This is an example of a paragraph in warning style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "6",
|
||||
"type": "Docs Important Style",
|
||||
"definition": "Use this style to communicate a tip or something important to the reader.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Whatever you type while editing will be rendered inside the importat box."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "This is an example of a paragraph in important style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "7",
|
||||
"type": "Docs Error Style",
|
||||
"definition": "This style is used by the system itself to show you when you entered incorrect parameters for some styles. You can use this style as well to show readers errors in the context of what you are explaining to them.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Anything you type while editing, will be displayed inside the error box."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Error",
|
||||
"text": "This is an example of a paragraph in error style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "8",
|
||||
"type": "Docs Success Style",
|
||||
"definition": "This style will render the text inside a success box.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Any text formatted with this style will be showed inside the success box."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "This is an example of a paragraph in success style."
|
||||
}
|
||||
]
|
||||
}
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"topic": "Docs Paragraph Styles",
|
||||
"pageNumber": "9",
|
||||
"type": "Docs List Style",
|
||||
"definition": "This style will render the text as an item of a bullet point list.",
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Any text you type while editting a paragraph of this style will be displayed as a item of a list, represented as a text after a bullet point. If you use colon quotation mark at some point in your text except at the end, all the text before the colon will be rendered in bold."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "For example: from here there is normal text."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Example:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Example:"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1258,7 +1258,7 @@ function newSuperalgosDocSpace() {
|
||||
function addConcept(project, type) {
|
||||
let template = {
|
||||
type: type,
|
||||
definition: "Write here the definition of this Concept.",
|
||||
definition: "Write here the summary / definition of this Concept.",
|
||||
paragraphs: [
|
||||
{
|
||||
style: "Text",
|
||||
@@ -1287,7 +1287,7 @@ function newSuperalgosDocSpace() {
|
||||
topic: topic,
|
||||
pageNumber: pageNumber,
|
||||
type: type,
|
||||
definition: "Write here the definition of this Concept.",
|
||||
definition: "Write here a summary for this topic page.",
|
||||
paragraphs: [
|
||||
{
|
||||
style: "Text",
|
||||
|
||||
Reference in new issue
Block a user