{"id":17124960,"url":"https://github.com/shellyln/mdne-sf","last_synced_at":"2026-05-08T18:33:12.540Z","repository":{"id":74004175,"uuid":"324693057","full_name":"shellyln/mdne-sf","owner":"shellyln","description":"Markdown Neo Edit for Salesforce - A simple markdown and code editor powered by Markdown-it and Ace.","archived":false,"fork":false,"pushed_at":"2020-12-28T03:57:17.000Z","size":3287,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-29T09:44:58.731Z","etag":null,"topics":["ace","code-editor","editor","lisp","lsx","markdown","markdown-editor","markdown-it","markdown-to-html","salesforce"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shellyln.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-12-27T05:24:33.000Z","updated_at":"2024-03-20T00:17:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"bff1f1fe-70f4-4364-8bce-1b4e4c8e8d67","html_url":"https://github.com/shellyln/mdne-sf","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/shellyln%2Fmdne-sf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Fmdne-sf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Fmdne-sf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Fmdne-sf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellyln","download_url":"https://codeload.github.com/shellyln/mdne-sf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245204410,"owners_count":20577346,"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":["ace","code-editor","editor","lisp","lsx","markdown","markdown-editor","markdown-it","markdown-to-html","salesforce"],"created_at":"2024-10-14T18:43:47.364Z","updated_at":"2026-05-08T18:33:10.805Z","avatar_url":"https://github.com/shellyln.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdne-sf - Markdown Neo Edit for Salesforce\n\n\u003cimg src=\"https://raw.githubusercontent.com/shellyln/mdne-sf/master/docs/logo.svg?sanitize=true\" title=\"logo\" style=\"width: 200px\"\u003e\n\n### A simple markdown and code editor powered by [Markdown-it](https://github.com/markdown-it/markdown-it) and [Ace](https://ace.c9.io/).\n\n![screenshot](https://raw.githubusercontent.com/shellyln/mdne-sf/master/docs/mdne-sf.png)\n\n\n## 💎 Features\n### 🟢 Salesforce integration features\n* Edit Salesforce record's field.\n* Markdown preview Visualforce example (For embedding in record detail page)\n\n### 🟢 Editor features\n* Live preview of Markdown, HTML, [LSX](https://github.com/shellyln/liyad#what-is-lsx) formats.\n* Export Markdown, HTML, and LSX into HTML.\n* Code highlighting\n  * C#\n  * CSS\n  * Dockerfile\n  * Go\n  * GraphQL\n  * HTML\n  * INI\n  * Java\n  * JavaScript\n  * JSON\n  * JSON5\n  * JSX\n  * Kotlin\n  * Latex\n  * Less\n  * Lisp\n  * Makefile\n  * Markdown\n  * Protobuf\n  * Python\n  * R\n  * Ruby\n  * Rust\n  * Sass\n  * Scss\n  * Shell script\n  * SQL\n  * SVG\n  * Tex\n  * TOML\n  * TSX\n  * TypeScript\n  * XML\n  * YAML\n* Markdown extended syntax\n  * Many markdown-it plugins are enabled. See [here](https://github.com/shellyln/menneu#features).\n* Scripting and value expansion\n  * See [here](https://github.com/shellyln/menneu#lisp-block-expansion).\n* Full screen mode (F11)\n\nFor more informations, see [mdne electron](https://github.com/shellyln/mdne-electron) repo.\n\n\n\n## 🚚 Distributions and Integrations\n\n* [mdne-sf](https://github.com/shellyln/mdne-sf)\n  * Edit Salesforce record's field. (browser app)\n    * *This repository*\n  * Markdown preview Visualforce page example\n* [mdne-electron](https://github.com/shellyln/mdne-electron)\n  * Standalone offline desktop app for Windows/Mac/Linux.\n    * [Electron](https://electronjs.org/) app\n* [mdne online](https://github.com/shellyln/mdne-electron)\n  * Online markdown editor for Chrome/Chromium Edge/Firefox.\n    * [PWA](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) (Progressive Web Apps)\n* [mdne (mdne-classic)](https://github.com/shellyln/mdne)\n  * Offline desktop app for Google Chrome browser + Node.js.\n    * [Carlo](https://github.com/GoogleChromeLabs/carlo) app\n* [mdne-for-kintone](https://github.com/shellyln/mdne-for-kintone)\n  * Edit kintone record's field. (browser app)\n\n\n\n## ⚙️ Setup a deployment and contribution environment\n\n```bash\ngit clone https://github.com/shellyln/mdne-sf.git\ncd mdne-sf\ngit checkout -b my-package-releases\n\n# Authorize a Dev-Hub org (if you haven't already done).\nsfdx force:auth:web:login \\\n    --setdefaultdevhubusername\n    --setalias my-hub-org\n\nsfdx force:org:create \\\n    --definitionfile config/project-scratch-def.json \\\n    --setalias MdneSfOrg \\\n    --durationdays 30 \\\n    --setdefaultusername\nnpm install\n\nsfdx force:source:push\nsfdx force:org:open\n\n# and try it!\n```\n\n\n\n## 📖 Usage\n\n### 🟢 Formula field to open the Markdown editor\n\n1. Click `⚙️Setup` menu and click `⚙️Setup`.\n1. Open `Object Manager` and select the object you want to add report. (e.g.: `Account`)\n1. Select `Fields \u0026 Relationships` menu and click `New`.\n    | Item | Value |\n    |------|-------|\n    | Object Name | `Account` |\n    | Field Label | `Open Editor` |\n    | Field Name | `OpenEditor` |\n    | API Name | `OpenEditor__c` |\n    | Data Type | `Formula (Text)` |\n    | Formula | `HYPERLINK(\"/apex/mdne#open.obj=Account\u0026open.field=Description\u0026open.id=\" \u0026 Id, \"Open Editor\", \"_blank\")` |\n    | Blank Field Handling | `Treat blank fields as blanks` |\n1. Click `Save` button.\n1. Select `Page Layouts` menu and add the field to the layout.\n\n\n\n### 🟢 Show the rendered markdown on the detail view page.\n\n1. Make a copy Visualforce page `MarkdownPreviewExample_Account` and edit it.\n1. Click `⚙️Setup` menu and click `⚙️Setup`.\n1. Open `Object Manager` and select the object you want to add report. (e.g.: `Account`)\n1. Select `Page Layouts` menu and add the copied Visualforce page to the layout.\n    | Item | Value |\n    |------|-------|\n    | Width | `100%` |\n    | Height | `200` |\n    | Show scrollbars | `false` |\n    | Show label | `false` |\n\n\n\n## 📦 Deploy the package (pre-release)\n\n```bash\nsfdx force:org:list\n\n# Specify the `USERNAME` or` ALIAS` of the DevHub org listed in the above command.\nsfdx force:package:create \\\n    -n MDNE \\\n    -d \"Report rendering library for Salesforce LWC and Visualforce\" \\\n    -r force-app \\\n    -t Unlocked \\\n    -v \u003cdevhub_org_username_or_alias\u003e\n\nsfdx force:package:list\n\ncat sfdx-project.json\n\nsfdx force:package:version:create \\\n    -p MDNE \\\n    -d force-app \\\n    -k test1234 \\\n    -v \u003cdevhub_org_username_or_alias\u003e \\\n    --codecoverage \\\n    --wait 10\n\nsfdx force:package:version:list --verbose\n\ngit add .\ngit commit -m \"v0.1.0-1\"\n\n# Install the package in your developer or sandbox org for testing.\nsfdx force:package:install \\\n    -u \u003ctarget_dev_or_sandbox_org_username_or_alias\u003e \\\n    --package MDNE@0.1.0-1 \\\n    -k test1234 \\\n    --wait 10 \\\n    --publishwait 10 \\\n    --noprompt\n```\n\n## 🚀 Deploy the package (production-release)\n\n```bash\n# Promote the package version to production.\nsfdx force:package:version:promote \\\n    -p MDNE@0.1.0-1 \\\n    -v \u003cdevhub_org_username_or_alias\u003e\n\n# Install the package in your production org.\nsfdx force:package:install \\\n    -u \u003ctarget_org_username_or_alias\u003e \\\n    --package MDNE@0.1.0-1 \\\n    -k test1234 \\\n    --wait 10 \\\n    --publishwait 10 \\\n    --noprompt\n```\n\n## 🚧 Manage the package and package versions\n\n```bash\nsfdx force:package:version:list --verbose\nsfdx force:package:version:delete -p 04tXXX\nsfdx force:package:delete -p 0HoXXX\n```\n\n\n----\n## License\n[ISC](https://github.com/shellyln/mdne-sf/blob/master/LICENSE.md)  \nCopyright (c) 2020 Shellyl_N and Authors.\n\n## Bundled softwares' license\n\n* [Ace](https://github.com/ajaxorg/ace): [license](https://github.com/ajaxorg/ace/blob/master/LICENSE) (BSD-3-Clause)\n* [Carlo](https://github.com/GoogleChromeLabs/carlo): [license](https://github.com/GoogleChromeLabs/carlo/blob/master/LICENSE) (Apache License 2.0)\n* [Materialize](https://materializecss.com/): [license](https://github.com/Dogfalo/materialize/blob/v1-dev/LICENSE) (MIT)\n* [Normalize.css](https://necolas.github.io/normalize.css/): [license](https://github.com/necolas/normalize.css/blob/master/LICENSE.md) (MIT)\n* [github-markdown-css](https://github.com/sindresorhus/github-markdown-css): [license](https://github.com/sindresorhus/github-markdown-css/blob/gh-pages/license) (MIT)\n* [highlight.js](https://github.com/highlightjs/highlight.js): [license](https://github.com/highlightjs/highlight.js/blob/master/LICENSE) (BSD 3-Clause)\n* [React](https://reactjs.org/): [license](https://github.com/facebook/react/blob/master/LICENSE) (MIT)\n* [pako](https://github.com/nodeca/pako): [license](https://github.com/nodeca/pako/blob/master/LICENSE) (MIT + ZLIB)\n* [dialog-polyfill](https://github.com/GoogleChrome/dialog-polyfill): [license](https://github.com/GoogleChrome/dialog-polyfill/blob/master/LICENSE) (BSD-3-Clause)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellyln%2Fmdne-sf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellyln%2Fmdne-sf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellyln%2Fmdne-sf/lists"}