{"id":15048705,"url":"https://github.com/jonasdoebertin/kirby-visual-markdown","last_synced_at":"2025-04-10T01:33:24.023Z","repository":{"id":29473181,"uuid":"33009849","full_name":"JonasDoebertin/kirby-visual-markdown","owner":"JonasDoebertin","description":"Visual Markdown Editor for Kirby CMS 2","archived":false,"fork":false,"pushed_at":"2018-02-09T11:07:53.000Z","size":1188,"stargazers_count":162,"open_issues_count":18,"forks_count":17,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-24T03:11:34.744Z","etag":null,"topics":["kirby","kirby-plugin","markdown-editor","php"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JonasDoebertin.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":"2015-03-27T21:24:09.000Z","updated_at":"2024-06-17T19:00:41.000Z","dependencies_parsed_at":"2022-08-27T05:52:00.727Z","dependency_job_id":null,"html_url":"https://github.com/JonasDoebertin/kirby-visual-markdown","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JonasDoebertin%2Fkirby-visual-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JonasDoebertin%2Fkirby-visual-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JonasDoebertin%2Fkirby-visual-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JonasDoebertin%2Fkirby-visual-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JonasDoebertin","download_url":"https://codeload.github.com/JonasDoebertin/kirby-visual-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140826,"owners_count":21054355,"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":["kirby","kirby-plugin","markdown-editor","php"],"created_at":"2024-09-24T21:15:32.747Z","updated_at":"2025-04-10T01:33:23.995Z","avatar_url":"https://github.com/JonasDoebertin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Visual Markdown Editor for Kirby](https://raw.githubusercontent.com/JonasDoebertin/kirby-visual-markdown/master/logo.gif)](https://github.com/JonasDoebertin/kirby-visual-markdown/)\n\n**Based on [CodeMirror](https://github.com/codemirror/CodeMirror). Inspired by [MirrorMark](https://github.com/musicbed/MirrorMark).**\n\n[![Release](https://img.shields.io/github/release/jonasdoebertin/kirby-visual-markdown.svg)](https://github.com/jonasdoebertin/kirby-mirrormark/releases)  [![Issues](https://img.shields.io/github/issues/jonasdoebertin/kirby-visual-markdown.svg)](https://github.com/jonasdoebertin/kirby-mirrormark/issues) [![License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://raw.githubusercontent.com/jonasdoebertin/kirby-mirrormark/master/LICENSE)\n[![Moral License](https://img.shields.io/badge/buy-moral_license-8dae28.svg)](https://gumroad.com/l/visualmarkdown)\n\nThis Panel field plugin for [Kirby 2](http://getkirby.com) enables you to use an intuitive and visual markdown editor without any hazzle. Just drop in the plugin and you're good to go!\n\n![Screenshot](https://raw.githubusercontent.com/JonasDoebertin/kirby-visual-markdown/master/screenshot.png)\n\n## Important Note (Please Read)\n\nGenerally, this extension is free to use on both personal and commercial Kirby powered sites. You don't *have* to pay for it. However, please always keep in mind that developing this extension took place in my spare time (and maybe a little bit of the time I should have spend on other work related stuff) and up until now, quite some hours have been spent on it..\n\nIf you like what I'm doing for the community and you want to support further development of this and future extensions \u0026 plugins for Kirby CMS, please consider [purchasing a moral license](https://gumroad.com/l/visualmarkdown).\n\n**This is especially appreciated whenever you use one of the extensions in a project that you get payed for.**\n\n*Cheers, Jonas*\n\n## Requirements\n\n* **Kirby 2.2 or above**\n* **PHP 5.4 or above**\n\n## Installation\n\n### Copy \u0026 Pasting\n\nIf not already existing, add a new `fields` folder to your `site` directory. Then copy or link this repositories whole content in a new `markdown` folder there. Afterwards, your directory structure should look similar to this:\n\n```\nsite/\n\tfields/\n\t\tmarkdown/\n\t\t\tassets/\n\t\t\tmarkdown.php\n```\n\n### Git Submodule\n\nIf you are an advanced user and know your way around Git and you already use Git to manage you project, you can make updating this field extension to newer releases a breeze by adding it as a Git submodule.\n\n```bash\n$ cd your/project/root\n$ git submodule add https://github.com/JonasDoebertin/kirby-visual-markdown.git site/fields/markdown\n```\n\nUpdating all your Git submodules (eg. the Kirby core modules and any extensions added as submodules) to their latest version, all you need to do is to run these two Git commands.\n\n```bash\n$ cd your/project/root\n$ git submodule foreach --recursive git checkout master\n$ git submodule foreach --recursive git pull\n```\n\n## Usage\n\n### Within your blueprints\n\nUsing the field in your blueprint couldn't be easier. After installing the plugin like explained above, all you need to do is change the `type` of your text fields to `markdown`.\n\n```\nfields:\n    title:\n        label: Post Title\n        type:  text\n    text:\n        label: Text\n        type:  markdown\n```\n\n*Fields related part of the blueprint for the setup shown in the screenshot.*\n\n### Within your templates\n\nYou don't have to change your templates in order to support this field. Just use content created with this field like any regular `textarea` field:\n\n```html\n\u003carticle\u003e\n\t\u003ch1\u003e\n\t\t\u003c?php echo $page-\u003etitle()-\u003ehtml() ?\u003e\n\t\u003c/h1\u003e\n\t\u003c?php echo $page-\u003etext()-\u003ekirbytext() ?\u003e\n\u003c/article\u003e\n```\n\n## Options\n\n### toolbar\n\nShow / hide the editor toolbar. Set this to `hide` if you want the toolbar to disappear. Per default, the toolbar will be shown.\n\n```\nfields:\n    text:\n        label:   Text\n        type:    markdown\n\t\ttoolbar: hide\n```\n\n### tools\n\nWith this option you may select which tools you want to show up in the toolbar. Specify a list of all tools you want to show up. *Please note that there are two toolbar items that will always shown: the help menu and the fullscreen mode icon.*\n\n```\nfields:\n    text:\n        label:   Text\n        type:    markdown\n\t\ttools:\n\t\t\t- bold\n\t\t\t- italic\n\t\t\t- orderedList\n\t\t\t- unorderedList\n```\n\n**Available tools:**\n\n* `header1`\n* `header2`\n* `bold`\n* `italic`\n* `blockquote`\n* `unorderedList`\n* `orderedList`\n* `link`\n* `image`\n* `line`\n\n### header1 \u0026 header2\n\nSpecify the header levels to be used with the *H1* and *H2* toolbar buttons (`h1` to `h6`). Defaults to `header1: h1` and `header2: h2`.\n\n```\nfields:\n    text:\n        label:   Text\n        type:    markdown\n\t\theader1: h2\n\t\theader2: h3\n```\n\n*If you have any suggestions for further configuration options, [please let me know](https://github.com/JonasDoebertin/kirby-visual-markdown/issues/new).*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonasdoebertin%2Fkirby-visual-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonasdoebertin%2Fkirby-visual-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonasdoebertin%2Fkirby-visual-markdown/lists"}