{"id":16977897,"url":"https://github.com/bxute/markdeditor","last_synced_at":"2025-03-17T08:38:08.765Z","repository":{"id":96632676,"uuid":"141544140","full_name":"bxute/MarkDEditor","owner":"bxute","description":"A WYSIWYG MarkDown editor for Android.","archived":false,"fork":false,"pushed_at":"2020-12-04T08:02:58.000Z","size":6304,"stargazers_count":91,"open_issues_count":7,"forks_count":18,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-27T21:48:37.896Z","etag":null,"topics":["custom-view","easy-to-use","markdown","markdown-editor","wysiwyg"],"latest_commit_sha":null,"homepage":"","language":"Java","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/bxute.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":"2018-07-19T07:53:42.000Z","updated_at":"2025-02-17T15:34:04.000Z","dependencies_parsed_at":"2023-04-14T18:46:57.652Z","dependency_job_id":null,"html_url":"https://github.com/bxute/MarkDEditor","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bxute%2FMarkDEditor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bxute%2FMarkDEditor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bxute%2FMarkDEditor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bxute%2FMarkDEditor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bxute","download_url":"https://codeload.github.com/bxute/MarkDEditor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243853657,"owners_count":20358454,"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":["custom-view","easy-to-use","markdown","markdown-editor","wysiwyg"],"created_at":"2024-10-14T01:30:03.387Z","updated_at":"2025-03-17T08:38:08.738Z","avatar_url":"https://github.com/bxute.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkDEditor [![](https://jitpack.io/v/bxute/MarkDEditor.svg)](https://jitpack.io/#bxute/MarkDEditor)\n#### A Markdown Editor For Android.\n\nYour editor will look something like:\n\n\u003cimg src=\"https://user-images.githubusercontent.com/10809719/43141356-50efed8a-8f73-11e8-860b-b88bafa2c8b8.png\" width=\"320px\" height=\"640px\"/\u003e \u003cimg align=\"right\" src=\"https://user-images.githubusercontent.com/10809719/43141350-4f74aa5e-8f73-11e8-9966-243383e7c7bc.png\" width=\"320px\" height=\"640px\"/\u003e\n\n**Supported Styles**\n - Normal Text\n - H1, H2, H3, H4, H5\n - UL (Unordered List)\n - OL (Ordered List)\n - Blockquote\n - Links\n - Horizontal rulers\n - Images.\n \n ### How to use it ?\n Step 1. Add the JitPack repository to your build file\n ```groovy\n allprojects {\n   repositories {\n     maven { url 'https://jitpack.io' }\n   }\n }\n```\n\nStep 2. Add the dependency\n```groovy\ndependencies {\n  implementation 'com.github.bxute:MarkDEditor:v0.16'\n}\n```\n\nStep 3. Add XML declaration\n```xml\n\u003cScrollView\n  android:background=\"#ffffff\"\n  android:layout_above=\"@+id/controlBar\"\n  android:layout_width=\"match_parent\"\n  android:layout_height=\"match_parent\"\u003e\n\n \u003cxute.markdeditor.MarkDEditor\n  android:id=\"@+id/mdEditor\"\n  android:layout_width=\"match_parent\"\n  android:layout_height=\"match_parent\" /\u003e\n\n\u003c/ScrollView\u003e\n\n\u003cxute.markdeditor.EditorControlBar\n  android:id=\"@+id/controlBar\"\n  android:layout_alignParentBottom=\"true\"\n  android:layout_width=\"match_parent\"\n  android:layout_height=\"48dp\" /\u003e\n```\n\nStep 4. In Activity file\n```java\nMarkDEditor markDEditor = findViewById(R.id.mdEditor);\neditorControlBar = findViewById(R.id.controlBar);\neditorControlBar.setEditorControlListener(this);\nmarkDEditor.configureEditor(\n     \"\",//server url for image upload\n     \"\",              //serverToken\n     true,           // isDraft: set true when you are loading draft\n     \"Type here...\", //default hint of input box\n     NORMAL\n    );\n//load draft\n//markDEditor.loadDraft(getDraftContent());\neditorControlBar.setEditor(markDEditor);\n```\n\nStep 5. Implement Callback methods\n```java\n@Override\n  public void onInsertImageClicked() {\n    //openGallery();\n  }\n\n  @Override\n  public void onInserLinkClicked() {\n    //markDEditor.addLink(\"Click Here\", \"http://www.hapramp.com\");\n    \n  }\n```\n\n**Inserting Image**\n```java\nmarkDEditor.insertImage(filePath);\n```\n\n**Inserting Link**\n```java\n markDEditor.addLink(\"Click Here\", \"http://www.hapramp.com\");\n```\n\u003e Note: You can add take input for link using a DialogFragment.\n\n\n**Getting Markdown from Editor**\n```java\nString md = markDEditor.getMarkdownContent();\n```\n\n**Getting List of Images**\n```java\nList\u003cString\u003e images = markDEditor.getImageList();\n```\n\n\n### Contributions\n\nAny contributions are welcome. You can send PR or open issues.\n\n### License\nMIT License\n\nCopyright (c) 2018 Hapramp Studio Pvt. Ltd.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbxute%2Fmarkdeditor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbxute%2Fmarkdeditor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbxute%2Fmarkdeditor/lists"}