{"id":18823061,"url":"https://github.com/sivamani-18/markdown-syntax","last_synced_at":"2025-08-06T13:03:35.289Z","repository":{"id":250983096,"uuid":"836037254","full_name":"Sivamani-18/Markdown-Syntax","owner":"Sivamani-18","description":"here is a comprehensive list of Markdown syntax along with examples for use in your README.md file, including Mermaid diagrams and code blocks for various programming languages.","archived":false,"fork":false,"pushed_at":"2024-07-31T04:06:11.000Z","size":4,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T18:02:29.685Z","etag":null,"topics":["developer-docs","diagrams","documentation","github-docs","github-readme","github-topics","markdown","markdown-best-practices","markdown-examples","markdown-syntax","markdown-tutorial","mermaid","mermaid-diagrams","project-documentation","readme-best-practices","readme-guide","readme-template","syntax-highlighting"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sivamani-18.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-07-31T03:22:40.000Z","updated_at":"2024-08-28T10:52:11.000Z","dependencies_parsed_at":"2024-07-31T06:19:33.624Z","dependency_job_id":null,"html_url":"https://github.com/Sivamani-18/Markdown-Syntax","commit_stats":null,"previous_names":["sivamani-18/markdown-syntax"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Sivamani-18/Markdown-Syntax","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivamani-18%2FMarkdown-Syntax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivamani-18%2FMarkdown-Syntax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivamani-18%2FMarkdown-Syntax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivamani-18%2FMarkdown-Syntax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sivamani-18","download_url":"https://codeload.github.com/Sivamani-18/Markdown-Syntax/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sivamani-18%2FMarkdown-Syntax/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269085239,"owners_count":24357190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["developer-docs","diagrams","documentation","github-docs","github-readme","github-topics","markdown","markdown-best-practices","markdown-examples","markdown-syntax","markdown-tutorial","mermaid","mermaid-diagrams","project-documentation","readme-best-practices","readme-guide","readme-template","syntax-highlighting"],"created_at":"2024-11-08T00:52:37.228Z","updated_at":"2025-08-06T13:03:35.212Z","avatar_url":"https://github.com/Sivamani-18.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Syntax\n\nThis is a comprehensive list of Markdown syntax along with examples for use in your README.md file, including Mermaid diagrams and code blocks for various programming languages.\n\n## Table of Contents\n\n1. [Headings](#headings-syntax)\n2. [Lists](#lists-syntax)\n3. [Links](#links-syntax)\n4. [Images](#images-syntax)\n5. [Blockquotes](#blockquotes-syntax)\n6. [Inline Code](#inline-code-syntax)\n7. [Code Blocks](#code-blocks-syntax)\n8. [Tables](#tables-syntax)\n9. [Horizontal Line](#horizontal-line-syntax)\n10. [Bold and Italics](#bold-and-italics-syntax)\n11. [Mermaid Diagrams](#mermaid-diagrams-syntax)\n\n\n## Headings Syntax\n```markdown\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n```\n\n### Example of Headings\n\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n\n\n## Lists Syntax\n**Unordered List:**\n```markdown\n- Item 1\n- Item 2\n  - Subitem 2.1\n  - Subitem 2.2\n- Item 3\n```\n\n**Ordered List:**\n```markdown\n1. First item\n2. Second item\n3. Third item\n   1. Subitem 3.1\n   2. Subitem 3.2\n```\n\n### Example of Unordered List\n\n- Item 1\n- Item 2\n  - Subitem 2.1\n  - Subitem 2.2\n- Item 3\n\n### Example of Ordered List\n\n1. First item\n2. Second item\n3. Third item\n   1. Subitem 3.1\n   2. Subitem 3.2\n\n## Links Syntax\n```markdown\n[GitHub](https://github.com/)\n```\n\n### Example of Links\n[GitHub](https://github.com/)\n\n## Images Syntax\n```markdown\n![Image Alt Text](https://via.placeholder.com/150)\n```\n\n### Example of Images\n![Image Alt Text](https://via.placeholder.com/150)\n\n## Blockquotes Syntax\n```markdown\n\u003e This is a blockquote.\n```\n\n### Example of Blockquotes\n\u003e This is a blockquote.\n\n## Inline Code Syntax\n```markdown\nInline `code` example.\n```\n\n### Example of Inline Code\nInline `code` example.\n\n## Code Blocks Syntax\nAdd ` ``` ` at the end of all code blocks Syntax.\n\n**JavaScript:**\n```markdown\n```javascript\nfunction greet() {\n    console.log(\"Hello, world!\");\n}\ngreet();\n```\n\n\n**Python:**\n```markdown\n```python\ndef greet():\n    print(\"Hello, world!\")\n\ngreet()\n```\n\n\n**Shell:**\n```markdown\n```sh\necho \"Hello, world!\"\n```\n\n\n### Example of Code Blocks\n**JavaScript:**\n```javascript\nfunction greet() {\n    console.log(\"Hello, world!\");\n}\ngreet();\n```\n\n\n**Python:**\n```python\ndef greet():\n    print(\"Hello, world!\")\n\ngreet()\n```\n\n\n**Shell:**\n```sh\necho \"Hello, world!\"\n```\n\n## Tables Syntax\n```markdown\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Row 1    | Data 1   | Data 2   |\n| Row 2    | Data 3   | Data 4   |\n```\n\n### Example of Tables\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Row 1    | Data 1   | Data 2   |\n| Row 2    | Data 3   | Data 4   |\n\n## Horizontal Line Syntax\n```markdown\n---\n```\n\n### Example of Horizontal Line\n---\n\n## Bold and Italics Syntax\n```markdown\n**Bold Text**\n*Italic Text*\n***Bold and Italic Text***\n```\n\n### Example of Bold and Italics\n**Bold Text**\n*Italic Text*\n***Bold and Italic Text***\n\n### Mermaid Diagrams Syntax\nAdd ` ``` ` at the end of all mermaid diagrams Syntax.\n\n**Flowchart:**\n```markdown\n```mermaid\ngraph TD\n    A[Start] --\u003e B{Is it?}\n    B --\u003e|Yes| C[Do something]\n    B --\u003e|No| D[Do something else]\n    C --\u003e E[End]\n    D --\u003e E[End]\n```\n\n**Sequence Diagram:**\n```markdown\n```mermaid\nsequenceDiagram\n    participant Alice\n    participant Bob\n    Alice-\u003e\u003eJohn: Hello John, how are you?\n    loop Healthcheck\n        John-\u003e\u003eJohn: Fight against hypochondria\n    end\n    Note right of John: Rational thoughts \u003cbr/\u003eprevail...\n    John--\u003e\u003eAlice: Great!\n    John-\u003e\u003eBob: How about you?\n    Bob--\u003e\u003eJohn: Jolly good!\n```\n\n**Class Diagram:**\n```markdown\n```mermaid\nclassDiagram\n    Animal \u003c|-- Duck\n    Animal \u003c|-- Fish\n    Animal \u003c|-- Zebra\n    Animal : +int age\n    Animal : +String gender\n    Animal: +isMammal()\n    Animal: +mate()\n    class Duck{\n        +String beakColor\n        +swim()\n        +quack()\n    }\n    class Fish{\n        -int sizeInFeet\n        -canEat()\n    }\n    class Zebra{\n        +bool is_wild\n        +run()\n    }\n```\n\n**State Diagram:**\n```markdown\n```mermaid\nstateDiagram\n    [*] --\u003e Still\n    Still --\u003e [*]\n    Still --\u003e Moving\n    Moving --\u003e Still\n    Moving --\u003e Crash\n    Crash --\u003e [*]\n```\n\n**Entity Relationship Diagram:**\n```markdown\n```mermaid\nerDiagram\n    CUSTOMER ||--o{ ORDER : places\n    ORDER ||--|{ LINE-ITEM : contains\n    CUSTOMER {\n        string name\n        string address\n        string phone\n    }\n    ORDER {\n        int orderNumber\n        string date\n    }\n    LINE-ITEM {\n        string productCode\n        int quantity\n        float price\n    }\n```\n\n**Gantt Chart:**\n```markdown\n```mermaid\ngantt\n    title A Gantt Diagram\n    dateFormat  YYYY-MM-DD\n    section Section\n    A task           :a1, 2024-01-01, 30d\n    Another task     :after a1  , 20d\n    section Another\n    Task in sec      :2024-01-12  , 12d\n    another task     : 24d\n```\n\n**Pie Chart:**\n```markdown\n```mermaid\npie\n    title Key Metrics\n    \"Sales\" : 35\n    \"Marketing\" : 20\n    \"Development\" : 25\n    \"Customer Support\" : 20\n```\n\n**Git Graph:**\n```markdown\n```mermaid\ngitGraph\n    commit\n    commit\n    branch develop\n    checkout develop\n    commit\n    commit\n    checkout main\n    merge develop\n    commit\n```\n\n### Example of Mermaid Diagrams\n\n**Flowchart:**\n```mermaid\ngraph TD\n    A[Start] --\u003e B{Is it?}\n    B --\u003e|Yes| C[Do something]\n    B --\u003e|No| D[Do something else]\n    C --\u003e E[End]\n    D --\u003e E[End]\n```\n\n**Sequence Diagram:**\n```mermaid\nsequenceDiagram\n    participant Alice\n    participant Bob\n    Alice-\u003e\u003eJohn: Hello John, how are you?\n    loop Healthcheck\n        John-\u003e\u003eJohn: Fight against hypochondria\n    end\n    Note right of John: Rational thoughts \u003cbr/\u003eprevail...\n    John--\u003e\u003eAlice: Great!\n    John-\u003e\u003eBob: How about you?\n    Bob--\u003e\u003eJohn: Jolly good!\n```\n\n**Class Diagram:**\n```mermaid\nclassDiagram\n    Animal \u003c|-- Duck\n    Animal \u003c|-- Fish\n    Animal \u003c|-- Zebra\n    Animal : +int age\n    Animal : +String gender\n    Animal: +isMammal()\n    Animal: +mate()\n    class Duck{\n        +String beakColor\n        +swim()\n        +quack()\n    }\n    class Fish{\n        -int sizeInFeet\n        -canEat()\n    }\n    class Zebra{\n        +bool is_wild\n        +run()\n    }\n```\n\n**State Diagram:**\n```mermaid\nstateDiagram\n    [*] --\u003e Still\n    Still --\u003e [*]\n    Still --\u003e Moving\n    Moving --\u003e Still\n    Moving --\u003e Crash\n    Crash --\u003e [*]\n```\n\n**Entity Relationship Diagram:**\n```mermaid\nerDiagram\n    CUSTOMER ||--o{ ORDER : places\n    ORDER ||--|{ LINE-ITEM : contains\n    CUSTOMER {\n        string name\n        string address\n        string phone\n    }\n    ORDER {\n        int orderNumber\n        string date\n    }\n    LINE-ITEM {\n        string productCode\n        int quantity\n        float price\n    }\n```\n\n**Gantt Chart:**\n```mermaid\ngantt\n    title A Gantt Diagram\n    dateFormat  YYYY-MM-DD\n    section Section\n    A task           :a1, 2024-01-01, 30d\n    Another task     :after a1  , 20d\n    section Another\n    Task in sec      :2024-01-12  , 12d\n    another task     : 24d\n```\n\n**Pie Chart:**\n```mermaid\npie\n    title Key Metrics\n    \"Sales\" : 35\n    \"Marketing\" : 20\n    \"Development\" : 25\n    \"Customer Support\" : 20\n```\n\n**Git Graph:**\n```mermaid\ngitGraph\n    commit\n    commit\n    branch develop\n    checkout develop\n    commit\n    commit\n    checkout main\n    merge develop\n    commit\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsivamani-18%2Fmarkdown-syntax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsivamani-18%2Fmarkdown-syntax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsivamani-18%2Fmarkdown-syntax/lists"}