{"id":19362687,"url":"https://github.com/smartdevicelink/sdl_markdown_spec","last_synced_at":"2026-02-27T09:46:10.056Z","repository":{"id":146486901,"uuid":"60781604","full_name":"smartdevicelink/sdl_markdown_spec","owner":"smartdevicelink","description":"Specification writing documentation in DocDown","archived":false,"fork":false,"pushed_at":"2019-06-21T17:33:15.000Z","size":59,"stargazers_count":3,"open_issues_count":4,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-11-18T09:20:19.091Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartdevicelink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-09T14:35:15.000Z","updated_at":"2025-09-07T04:35:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"60e20e4a-a38b-4fe9-a6a6-ad01a57b000a","html_url":"https://github.com/smartdevicelink/sdl_markdown_spec","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/smartdevicelink/sdl_markdown_spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Fsdl_markdown_spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Fsdl_markdown_spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Fsdl_markdown_spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Fsdl_markdown_spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartdevicelink","download_url":"https://codeload.github.com/smartdevicelink/sdl_markdown_spec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Fsdl_markdown_spec/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29889950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T08:34:21.514Z","status":"ssl_error","status_checked_at":"2026-02-27T08:32:38.035Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T07:29:54.949Z","updated_at":"2026-02-27T09:46:10.025Z","avatar_url":"https://github.com/smartdevicelink.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# DocDown Format\nv 1.0\n\n---\n\n## Directory Structure\nThe repository will contain the following files at the root level:\n\n- `docs` This folder will be the root of the documentation.\n- `LICENSE` The license for the documentation\n- `config.json` Navigation structure and optional repo configuration\n\n#### config.json\nThis file contains a dictionary of all sections and classes contained in the repository, in the order in which they will appear on the developer portal. It also allows the option to override the default language and default asset directory.\n\n#### /docs\nThe root level of /docs contains an “assets” directory for storage of global assets, an “index.md” file for root-level content, and individual directories for each section or class. Directories can contain spaces.\n\nEach directory in /docs can contain an “index.md”  which contains the documentation in the Markdown format as described below.\n\nIn addition to the Markdown file, assets like code samples, tables, and images, can be stored in an “assets” folder next to the index.md file. Supported files are listed in the [Importing Files](#importing-files) section.\n\n\nWhen referencing assets, the parser will first look at the /assets directory at the same level as the “index.md” file. If the asset is not found, the parser will look up the directory tree until it reaches the global /assets directory. Assets cannot be shared across repositories.\n\n![Example Directory Structure](https://github.com/smartdevicelink/sdl_markdown_spec/blob/master/assets/image01.png)\n\n#### Nesting\nMaximum pages level in hierarchy is 2 only.\n\nExample:\n```\ndocs \\\n\tLevel 1 \\\n\t\tindex.md\n\t\tlevel 2 \\\n\t\t\tindex.md\n\t\tlevel 2 \\\n\t\t\tindex.md\n\t\t...\n\tlevel 1 \\\n\t\tindex.md\n\t...\n```\n\n## Basic Markdown Syntax\n#### Page headers\n###### H1\n**NOTE**: H1 is reserved for page titles and shouldn’t be used in the documentation\n`#`\n\n###### H2\nPage Section Titles\n`##`\n\n###### H3\nSub-Section Titles\n`###`\n\n###### H4\nChart Titles\n`####`\n\n###### H5\nNotes, Chart Column Titles\n`#####`\n\n###### H6\nChart Row Titles\n`######`\n\n###### Header anchor\nEach Header could be used as [anchor links](#anchor-links)\nThe rule for links is following:\n\n- remove '.' (dots)\n- replace ' ' (spaces) with '-' (hyphen)\n- convert all upper case letters to lower case\n\nExample:\n```\n##  4.1.4  Chapter 4.1.4 References\n---\n[link text](#--414--chapter-414-references)\n```\n\n#### Text Styling\n###### Emphasis\n`_emphasis_`, or `*emphasis*`\n\n###### Strong\n`__strong__`, or `**strong**`\n\n###### Strikethrough\n`~~strikethrough~~`\n\n###### Inline Code\n```\n`code`\n```\n\n###### Block Code\n\u003e \\`\\`\\`language\n\u003e Class = new className;\n\u003e \\`\\`\\`\n\n###### Blockquotes\nSupports nested blockquotes\n`\u003e`\n\n#### Lists\n###### Unordered list\n```\n- List item 1\n- List item 2\n```\n\n###### Ordered list\n```\n1. Item 1\n1. Item 2\n```\n\n#### Links\n###### Inline Link\n`[link text](https://www.google.com)`\n###### Inline Link + Title\n`[link text](https://www.google.com “Title”)`\n\n###### Reference Link\n```\n[link text][reference text]\n---\n[reference text]: https://www.google.com\n```\n\n###### Anchor links\n`[link text](#achor)`\n\n#### Images\n###### Inline Image\n`![alt text](https://google.com/image.png \"Title Text\")`\n\n###### Reference Image\n```\n![alt text][image]\n---\n[image]: https://google.com/image.png \"Title Text\"\n```\n\n\n#### Tables\n###### Table Structure\n```\n| Header           | Header 2           | Header 3           |\n| ---------------- | ------------------ | ------------------ |\n| cell content     | cell content       | cell content       |\n```\n\n###### Center align column\n```\n| Header           | Header 2           | Header 3           |\n| :--------------: | ------------------ | ------------------ |\n```\n\n\n##### Right align column\n```\n| Header           | Header 2           | Header 3           |\n| ---------------: | ------------------ | ------------------ |\n```\n\n\n#### Page Elements\n###### Horizontal Rule\n`---`\n\n###### Line Break\n```\nLine 1 text\nLine 2 text\n```\n\n##### Paragraph Break\n```\nLine 1 text\n\nLine 2 text\n```\n\n\n## Extended Markdown Syntax\n#### Notes\n###### Generic Note\nFenced by !!!.  Supports inline markdown. Content can start on first line or new line. “NOTE” type is optional, as it is the default.\n\n```\n!!! NOTE\nContent\n!!!\n```\n\n###### Important Note\n```\n!!! IMPORTANT\nContent\n!!!\n```\n\n###### Developer Must\n```\n!!! MUST\nContent\n!!!\n```\n\n###### Developer May\n```\n!!! MAY\nContent\n!!!\n```\n\n###### Sequencing Charts\nLink to Sequencing Chart\n\n```\n|||\nContent\n![alt text](assets/diagram.jpg)\n|||\n```\n\n\n## Links\n###### Link to another class\n`[link text][Class Name]` or\n`[link text][parent/ClassName]`\nLinks without a leading slash are treated as links between documents by the parser. The parent directory can be included to handle namespace conflicts.\n\n###### Link to a specific version\n`[link text][version/ClassName]`\nIf omitted, the latest version is used for the link\n\n###### Link to a specific constant in a class or method\n`[link text][version/Class Name/constant]`\n`[link text][version/Class Name/method]`\n\n###### Link between platforms\n`[link text][platform/version/Class Name/constant]`\nAllows the link to traverse repos (linking iOS to Core). Version and Constant are optional.\n\n## Document Metadata\nA document can begin with a metadata section defined by “---” with keys and values as shown below:\n\n```\n---\nkey: value\nkey2: value2\n---\n```\n\n## HTML\nDocDown converts documents from Markdown into HTML, therefore most HTML tags are supported.  Use HTML tags with caution as each template can render the them differently leading to unexpected outcomes.\n\n## Language Support\nLocalization of files is handled by appending the language code to the file itself. Directories currently cannot be localized. The default language is `_en_us` and is optional. Assets can be localized as well, in the same fashion.\n\n## Importing Files\nExternal code snippets can be imported and will be parsed using their native language. CSV imports will create HTML tables from their content. The parser will look in the assets/ directory for all imported files.\n\n`+++ file.m`\n\n`+++ response.json` would import a JSON code snippet from `assests/response.json`.\n\nSupported file types:\n* JSON\n* CSV\n* HTML\n* JS\n* CSS\n* Obj-C\n* Swift\n* Java\n* C++\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Fsdl_markdown_spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartdevicelink%2Fsdl_markdown_spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Fsdl_markdown_spec/lists"}