{
"title": "xLog Flavored Markdown",
"tags": [
"post",
"Wiki"
],
"summary": "This post is to explain and demonstrate the Markdown syntax supported by xLog.",
"sources": [
"xlog"
],
"external_urls": [
"https://xlog.xlog.app/xfm"
],
"date_published": "2022-11-01T17:53:05.594Z",
"content": ":::div{style=\"max-width: 100px\"}\n\n:::\n\nThis post is to explain and demonstrate the Markdown syntax supported by xLog.\n\nIf you have any questions or suggestions, feel free to submit an issue or comment.\n\n## Follows GitHub Flavored Markdown (GFM)\n\nSpecification details: https://github.github.com/gfm\n\nExamples:\n\n1. `## Heading level 2`\n\n ## Heading level 2\n\n1. `**Bold**`\n\n **Bold**\n\n1. `> Quote`\n \n > Quote\n\n1. List\n\n 1. Normal list\n\n <pre>- list 1\n - list 2</pre>\n\n - list 1\n - list 2\n\n 1. Ordered list\n\n <pre>1. - ordered list 1\n 1. - ordered list 2</pre>\n\n 1. ordered list 1\n 1. ordered list 2\n \n 1. Task list\n\n <pre>- [ ] task list 1\n - [x] task list 2</pre>\n\n - [ ] task list 1\n - [x] task list 2\n\n1. Code\n\n <pre>`code`</pre>\n\n `code`\n\n <pre>\n ```js\n console.log(\"xLog\")\n console.log(\"is the best!\")\n ```\n </pre>\n\n ```js\n console.log(\"xLog\")\n console.log(\"is the best!\")\n ```\n\n1. Thematic break `---`\n\n ---\n\n1. Link `[link title](url)`\n\n [link title](url)\n\n1. Image ``\n\n \n\n1. `*Italic*`\n\n *Italic*\n\n1. Autolink\n\n https://xlog.app\n\n1. `~~Strikethrough~~`\n\n ~~Strikethrough~~\n\n1. Table\n\n | foo | bar |\n | --- | --- |\n | baz | bim |\n\n## Allowed HTML Tags and Attributes\n\nSee: https://github.com/Crossbell-Box/xLog/blob/main/src/markdown/sanitize-schema.ts\n\nFor security reasons, only whitelisted HTML tags and attributes are allowed, but this is not set in stone, so if you need other tags or attributes, feel free to submit a pr or issue.\n\nExamples:\n\n```html\n<audio src=\"https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/TearsOfSteel.mp4\" controls></audio>\n```\n\n<audio src=\"https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/TearsOfSteel.mp4\" controls></audio>\n\n## Supports Generic Directives Proposal\n\nSpecification details: https://talk.commonmark.org/t/generic-directives-plugins-syntax/444\n\nExamples:\n\n1. `line1 :br line2 :i[HTML]{class=\"test\"}` => `line1 <br> line2 <i class=\"test\">HTML</i>`\n\n line1 :br line2 :i[HTML]{title=\"HyperText Markup Language\"}\n\n2. `::video[title]{src=https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/TearsOfSteel.mp4 controls=true}` => `<video src=\"https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/TearsOfSteel.mp4\" controls=\"\">title</video>`\n\n ::video[title]{src=https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/TearsOfSteel.mp4 controls=true}\n\n3. ```\n :::div{style=\"text-align: center\"}\n Centered Content\n :::\n ```\n => `<div style=\"text-align: center\"><p>Centered Content</p></div>`\n\n :::div{style=\"text-align: center\"}\n Centered Content\n :::\n\n## Supports Mathematical Expressions\n\nThis sentence uses `$` delimiters to show math inline: `$\\sqrt{3x-1}+(1+x)^2$` $\\sqrt{3x-1}+(1+x)^2$\n\nTo add a math expression as a block, start a new line and delimit the expression with two dollar symbols $$.\n\n```\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\n```\n\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\n\n## Built-in components\n\n### YouTube\n\n`::youtube{#pLBX9vdrtn4}`\n\n::youtube{#pLBX9vdrtn4}\n\n### Mention\n\n`:mention{#xlog}`\n\n:mention{#xlog}",
"attributes": [
{
"value": "xfm",
"trait_type": "xlog_slug"
}
]
}
