{"id":15008633,"url":"https://github.com/autokaka/refined_markdown","last_synced_at":"2025-04-09T16:05:38.304Z","repository":{"id":56838031,"uuid":"253022020","full_name":"Autokaka/refined_markdown","owner":"Autokaka","description":"A simple Markdown renderer that is written mostly in dart (grammar analysing and rendering part). Simple, quiet, fast, that is all refined markdown is intended to be.","archived":false,"fork":false,"pushed_at":"2020-06-18T18:03:53.000Z","size":3120,"stargazers_count":25,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T16:05:24.759Z","etag":null,"topics":["android","dart","dart-package","dart-packages","dartlang","flutter","ios"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/refined_markdown","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Autokaka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-04T14:44:45.000Z","updated_at":"2024-08-12T06:50:30.000Z","dependencies_parsed_at":"2022-09-12T11:20:21.145Z","dependency_job_id":null,"html_url":"https://github.com/Autokaka/refined_markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autokaka%2Frefined_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autokaka%2Frefined_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autokaka%2Frefined_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autokaka%2Frefined_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Autokaka","download_url":"https://codeload.github.com/Autokaka/refined_markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065288,"owners_count":21041871,"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","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":["android","dart","dart-package","dart-packages","dartlang","flutter","ios"],"created_at":"2024-09-24T19:19:49.040Z","updated_at":"2025-04-09T16:05:38.289Z","avatar_url":"https://github.com/Autokaka.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Refined Markdown\n\n[![pub](https://img.shields.io/badge/dynamic/json?color=blue\u0026label=pub\u0026query=latestStableVersion\u0026url=https%3A%2F%2Fpub.dartlang.org%2Fapi%2Fdocumentation%2Frefined_markdown)](https://pub.dartlang.org/packages/refined_markdown) ![travis](https://travis-ci.org/Autokaka/refined_markdown.svg?branch=master)\n\n## What is it?\n\nA **simple** Markdown renderer (for now) that is written mostly in dart (grammar analysing and rendering part).\n\n## Demo preview\n\n![demo1](https://raw.githubusercontent.com/Autokaka/refined_markdown/master/assets/demo1.jpg) ![demo2](https://raw.githubusercontent.com/Autokaka/refined_markdown/master/assets/demo2.jpg) ![demo3](https://raw.githubusercontent.com/Autokaka/refined_markdown/master/assets/demo3.jpg) ![demo4](https://raw.githubusercontent.com/Autokaka/refined_markdown/master/assets/demo4.jpg) ![demo5](https://raw.githubusercontent.com/Autokaka/refined_markdown/master/assets/demo5.jpg)\n\n## How to use it?\n\nUsing RefinedMarkdown is simple. What you need to do is generally like this:\n\n```dart\n// main.dart\nimport 'package:flutter/material.dart';\nimport 'package:refined_markdown/refined_markdown.dart';\n\nvoid main() {\n  runApp(MyApp());\n}\n\nclass MyApp extends StatefulWidget {\n  MyApp({Key key}) : super(key: key);\n\n  @override\n  _MyAppState createState() =\u003e _MyAppState();\n}\n\nclass _MyAppState extends State\u003cMyApp\u003e {\n  @override\n  Widget build(BuildContext context) {\n    return MaterialApp(\n      debugShowCheckedModeBanner: false,\n      home: MarkdownPage(),\n    );\n  }\n}\n\nclass MarkdownPage extends StatefulWidget {\n  @override\n  _MarkdownPageState createState() =\u003e _MarkdownPageState();\n}\n\nclass _MarkdownPageState extends State\u003cMarkdownPage\u003e {\n  @override\n  Widget build(BuildContext context) {\n    CSS baseCSS = CSS();\n    baseCSS.fontSize = 13;\n    return Scaffold(\n      appBar: AppBar(\n        elevation: 0,\n        title: Text('Markdown Test'),\n      ),\n      body: RefinedMarkdown(\n        text: r\"\"\"\n        Contents that are written in Markdown format\n\t\t\t\t\"\"\",\n        css: baseCSS,\n      ),\n    );\n  }\n}\n```\n\n**The key part of the code above is:**\n\n```dart\n@override\n  Widget build(BuildContext context) {\n    CSS baseCSS = CSS();\n    baseCSS.fontSize = 13;\n    return Scaffold(\n      appBar: AppBar(\n        elevation: 0,\n        title: Text('Markdown Test'),\n      ),\n      body: RefinedMarkdown(\n        text: r\"\"\"\n        Contents that are written in Markdown format\n        \"\"\",\n        css: baseCSS,\n      ),\n    );\n  }\n```\n\n## What are supported now?\n\ntaml, code block, code segmentation, task list, normal list, sequence list, title, bold text, italic text, delete line, text highlight, text style, network photo, link, divider\n\n## What are the meanings of those params?\n\n### RefinedMarkdown\n\n| param | type   | explanation                                                                                                                                                                                                                                                             | is required |\n| ----- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| text  | String | The **raw** text of a markdown string, please notice that.                                                                                                                                                                                                              | yes         |\n| css   | CSS    | The cascading style sheet (in concept) that helps you **build the basic style** of your markdown texts to be rendered. In detail, The rendered text style like the style of “## header2” will be rendered on the basis of the basic style (baseCSS in code demo above). | yes         |\n\n### CSS\n\n| param           | type  | default value      | explanation                                   | is required |\n| --------------- | ----- | ------------------ | --------------------------------------------- | ----------- |\n| fontSize        | int   | 11                 | The size of the text                          | no          |\n| fontColor       | Color | Colors.black87     | The color of the text                         | no          |\n| backgroundColor | Color | Colors.transparent | The color of the background of **each** text  | no          |\n| isItalic        | bool  | false              | Whether the text is displayed in bold style   | no          |\n| isBold          | bool  | false              | Whether the text is displayed in italic style | no          |\n| deleted         | bool  | false              | Whether the text is shown with line-through   | no          |\n| underline       | bool  | false              | Whether to show an underline                  | no          |\n\n## Using packages\n\n- [cached_network_image](https://pub.flutter-io.cn/packages/cached_network_image) for network images\n- [highlight](https://pub.flutter-io.cn/packages/highlight) for code blocks highlight\n- [url_launcher](https://pub.flutter-io.cn/packages/url_launcher) for launching links\n\n## What’s more\n\nThis package is using its own way to transfer markdown string to flutter widget without using any html/markdown packages for the base. It still get long way to go. More markdown standards will be supported in later version of refined_markdown in the following versions this summer :) ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautokaka%2Frefined_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautokaka%2Frefined_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautokaka%2Frefined_markdown/lists"}