{"id":13434921,"url":"https://github.com/TheodoreChu/marp-editor","last_synced_at":"2025-03-18T02:30:37.211Z","repository":{"id":45721658,"uuid":"324239468","full_name":"TheodoreChu/marp-editor","owner":"TheodoreChu","description":"Marp Editor for @standardnotes. Create presentations with Marp and Marpit Markdown | https://marpeditor.com","archived":false,"fork":false,"pushed_at":"2021-01-06T21:43:51.000Z","size":9320,"stargazers_count":26,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-01T03:14:06.993Z","etag":null,"topics":["deck","markdown","marp","marpit-markdown","presentation","presentation-slides","slides"],"latest_commit_sha":null,"homepage":"https://demo.marpeditor.com","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/TheodoreChu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"theodorechu","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-12-24T21:32:23.000Z","updated_at":"2024-07-22T20:26:42.000Z","dependencies_parsed_at":"2022-09-11T15:30:19.965Z","dependency_job_id":null,"html_url":"https://github.com/TheodoreChu/marp-editor","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheodoreChu%2Fmarp-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheodoreChu%2Fmarp-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheodoreChu%2Fmarp-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheodoreChu%2Fmarp-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheodoreChu","download_url":"https://codeload.github.com/TheodoreChu/marp-editor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221704621,"owners_count":16866797,"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":["deck","markdown","marp","marpit-markdown","presentation","presentation-slides","slides"],"created_at":"2024-07-31T03:00:27.411Z","updated_at":"2024-10-27T16:31:25.892Z","avatar_url":"https://github.com/TheodoreChu.png","language":"JavaScript","funding_links":["https://github.com/sponsors/theodorechu"],"categories":["markdown","Ecosystem","Extensions"],"sub_categories":["Community","Editors"],"readme":"# Marp Editor for Standard Notes\n\n\u003cdiv align=\"center\"\u003e\n\n[![Release](https://img.shields.io/github/release/theodorechu/marp-editor.svg)](https://github.com/theodorechu/marp-editor/releases)\n[![License](https://img.shields.io/github/license/theodorechu/marp-editor?color=blue)](https://github.com/theodorechu/marp-editor/blob/main/LICENSE)\n[![Status](https://img.shields.io/badge/status-open%20beta-brightgreen.svg)](https://marpeditor.com/#installation)\n[![Cost](https://img.shields.io/badge/cost-free-darkgreen.svg)](https://marpeditor.com/#installation)\n[![GitHub issues](https://img.shields.io/github/issues/theodorechu/marp-editor.svg)](https://github.com/theodorechu/marp-editor/issues/)\n[![Slack](https://img.shields.io/badge/slack-standardnotes-CC2B5E.svg?style=flat\u0026logo=slack)](https://standardnotes.org/slack)\n[![Downloads](https://img.shields.io/github/downloads/theodorechu/marp-editor/total.svg?style=flat)](https://github.com/theodorechu/marp-editor/releases)\n[![GitHub Stars](https://img.shields.io/github/stars/theodorechu/marp-editor?style=social)](https://github.com/theodorechu/marp-editor)\n\n\u003c/div\u003e\n\n## Introduction\n\nThe Marp Editor is an **unofficial** [editor](https://standardnotes.org/help/77/what-are-editors) for [Standard Notes](https://standardnotes.org), a free, [open-source](https://standardnotes.org/knowledge/5/what-is-free-and-open-source-software), and [end-to-end encrypted](https://standardnotes.org/knowledge/2/what-is-end-to-end-encryption) notes app.\n\nTry the demo at [demo.marpeditor.com](https://demo.marpeditor.com) or learn more at [marpeditor.com](https://marpeditor.com).\n\nThe Marp Editor is used to create presentation slides using [Marpit Markdown](https://marpit.marp.app/markdown).\n\nFor a full tutorial on how to use Marpit Markdown, please see the [official Marpit documentation](https://marpit.marp.app/markdown).\n\nThe Marp Editor is built with React, TypeScript, Sass, and [Marp](https://marp.app).\n\n## Features\n\n- Create presentation slides using [Marpit Markdown](https://marpit.marp.app/markdown).\n- Three modes: Edit, Split, and View.\n- Button to download the slides as an HTML file with presentation tools: buttons for previous slide, next slide, toggle fullscreen, and open presenter view. Provided by Bespoke and Screenfull as is usually included by Marp.\n- Button to print the slides. To save the slides as a PDF, use Microsoft Edge or Chrome.\n\n## Installation\n\n1. Register for an account at Standard Notes using the [Desktop App](https://standardnotes.org/download) or [Web app](https://app.standardnotes.org). Remember to use a strong and memorable password.\n2. In the bottom left corner of the app, click **Extensions**.\n3. Click **Import Extension**.\n4. Paste this into the input box:\n   ```\n   https://notes.theochu.com/p/PvmDopgufD\n   ```\n   or paste this into the input box on **desktop**:\n   ```\n   https://raw.githubusercontent.com/TheodoreChu/marp-editor/main/public/demo.ext.json\n   ```\n5. Press Enter or Return on your keyboard.\n6. Click **Install**.\n7. At the top of your note, click **Editor**, then click **Marp Editor**.\n8. When prompted to activate the extension, click **Continue**.\n\nAfter you have installed the editor on the web or desktop app, it will automatically sync to your [mobile app](https://standardnotes.org/download) after you sign in.\n\n## Example\n\nPaste this into the Marp Editor to see an example of what you can do with it:\n\n````md\n---\nmarp: true\ntheme: gaia\n_class: lead\npaginate: true\nbackgroundColor: #fff\nbackgroundImage: url('https://marp.app/assets/hero-background.jpg')\n---\n\n# **Marp Editor for Standard Notes**\n\nPowered by [Marp](https://marp.app), a Markdown Presentation Ecosystem\n\nhttps://marpeditor.com\n\n---\n\n# How to write slides\n\nSplit pages by horizontal ruler (`---`). It's very simple! :slightly_smiling_face:\n\n```md\n# Slide 1\n\nText for Slide 1\n\n---\n\n# Slide 2\n\nText for Slide 2\n```\n\n---\n\n# Features\n\n- Create presentation slides using [Marpit Markdown](https://marpit.marp.app/markdown).\n- Three modes: Edit, Split, and View.\n- Button to download the slides as an HTML file\n  - HTML file comes with presentation tools: buttons for previous slide, next slide, toggle fullscreen, and open presenter view.\n    - Provided by Bespoke and Screenfull as is usually included by Marp.\n- Button to print the slides. To save the slides as a PDF, use Microsoft Edge or Chrome.\n\n---\n\n# Features Continued\n\n- CommonMark provided by Markdown-It\n- Inline HTML and CSS\n- Math provided by $\\KaTeX$\n- GitHub Emoji support :smile:\n````\n\n## Development\n\n**Prerequisites:** Install [Node.js](https://nodejs.org/en/), [Yarn](https://classic.yarnpkg.com/en/docs/install/), and [Git](https://github.com/git-guides/install-git) on your computer.\n\nThe general instructions setting up an environment to develop Standard Notes extensions can be found [here](https://docs.standardnotes.org/extensions/local-setup). You can also follow these instructions:\n\n1. Fork the [repository](https://github.com/theodorechu/marp-editor) on GitHub.\n2. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your fork of the repository.\n3. Run `cd marp-editor` to enter the `marp-editor` directory.\n4. Run `yarn install` to install the dependencies on your machine as they are described in `yarn.lock`.\n\n### Testing in the browser\n\n1. To run the app in development mode, run `yarn start` and visit http://localhost:3001. Press `ctrl/cmd + C` to exit development mode.\n\n### Testing in the Standard Notes app\n\n1.  Create an `ext.json` in the `public` directory. You have three options:\n    1.  Use `sample.ext.json`.\n    2.  Create `ext.json` as a copy of `sample.ext.json`.\n    3.  Follow the instructions [here](https://docs.standardnotes.org/extensions/local-setup) with `url: \"http://localhost:3000/index.html\"`.\n2.  Install http-server using `sudo npm install -g http-server` then run `yarn server` to serve the `./build` directory at http://localhost:3000.\n3.  To build the app, run `yarn build`.\n4.  Install the editor into the [web](https://app.standardnotes.org) or [desktop](https://standardnotes.org/download) app with `http://localhost:3000/sample.ext.json` or with your custom `ext.json`. Press `ctrl/cmd + C` to shut down the server.\n\n### Deployment\n\n1. To make the source code prettier, run `yarn pretty`.\n2. To the deploy the build into the `gh-pages` branch of your repository on GitHub, run `yarn deploy-stable`.\n3. To deploy the build into to the `dev` branch for testing, run `yarn deploy-dev`.\n4. To deploy the built into the `build` branch for distributing, run `yarn deploy-build` for distributing builds.\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n### Available Scripts\n\nIn the project directory, you can run:\n\n#### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3001](http://localhost:3001) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n#### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n#### `yarn build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n#### `yarn eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can't go back!**\n\nIf you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.\n\nYou don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.\n\n#### Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n## License\n\nCopyright (c) Theodore Chu. All Rights Reserved. Licensed under [AGPL-3.0](https://github.com/TheodoreChu/marp-editor/blob/main/LICENSE) or later.\n\n## Acknowledgements\n\nEarly stages of this editor were based heavily on the Standard Notes [Markdown Basic Editor](https://github.com/standardnotes/markdown-basic). The Markdown Basic Editor is licensed under AGPL-3.0 and is available for use through [Standard Notes Extended](https://standardnotes.org/extensions).\n\n## Further Resources\n\n- [GitHub](https://github.com/TheodoreChu/marp-editor) for the source code of the Marp Editor\n- [GitHub Issues](https://github.com/TheodoreChu/marp-editor/issues) for reporting issues concerning the Marp Editor\n- [Docs](https://docs.theochu.com/marp-editor) for how to use the Marp Editor\n- [Contact](https://theochu.com/contact) for how to contact the developer of the Marp Editor\n- [Marp Editor To do List](https://github.com/TheodoreChu/marp-editor/projects/1) for the roadmap of the Marp Editor\n- [Standard Notes Slack](https://standardnotes.org/slack) for connecting with the Standard Notes Community\n- [Standard Notes Help](https://standardnotes.org/help) for help with issues related to Standard Notes but unrelated to this editor\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheodoreChu%2Fmarp-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTheodoreChu%2Fmarp-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheodoreChu%2Fmarp-editor/lists"}