The Marp Editor is used to create presentation slides using Marpit Markdown.
For a full tutorial on how to use Marpit Markdown, please see the official Marpit documentation.
The Marp Editor is built with React, TypeScript, Sass, and Marp.
- Create presentation slides using Marpit Markdown.
- Three modes: Edit, Split, and View.
- 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.
- Button to print the slides. To save the slides as a PDF, use Microsoft Edge or Chrome.
- Register for an account at Standard Notes using the Desktop App or Web app. Remember to use a strong and memorable password.
- In the bottom left corner of the app, click Extensions.
- Click Import Extension.
- Paste this into the input box:or paste this into the input box on desktop:
- Press Enter or Return on your keyboard.
- Click Install.
- At the top of your note, click Editor, then click Marp Editor.
- When prompted to activate the extension, click Continue.
After you have installed the editor on the web or desktop app, it will automatically sync to your mobile app after you sign in.
The general instructions setting up an environment to develop Standard Notes extensions can be found here. You can also follow these instructions:
- Fork the repository on GitHub.
- Clone your fork of the repository.
cd marp-editorto enter the
yarn installto install the dependencies on your machine as they are described in
Testing in the browser
- To run the app in development mode, run
yarn startand visit http://localhost:3001. Press
ctrl/cmd + Cto exit development mode.
Testing in the Standard Notes app
- Create an
publicdirectory. You have three options:
ext.jsonas a copy of
- Follow the instructions here with
- Install http-server using
sudo npm install -g http-serverthen run
yarn serverto serve the
./builddirectory at http://localhost:3000.
- To build the app, run
- Install the editor into the web or desktop app with
http://localhost:3000/sample.ext.jsonor with your custom
ctrl/cmd + Cto shut down the server.
- To make the source code prettier, run
- To the deploy the build into the
gh-pagesbranch of your repository on GitHub, run
- To deploy the build into to the
devbranch for testing, run
- To deploy the built into the
buildbranch for distributing, run
yarn deploy-buildfor distributing builds.
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.\ Open http://localhost:3001 to view it in the browser.
The page will reload if you make edits.\ You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.
Builds the app for production to the
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you
eject, you can't go back!
If 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.
Instead, 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.
You 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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Copyright (c) Theodore Chu. All Rights Reserved. Licensed under AGPL-3.0 or later.
Early stages of this editor were based heavily on the Standard Notes Markdown Basic Editor. The Markdown Basic Editor is licensed under AGPL-3.0 and is available for use through Standard Notes Extended.
- GitHub for the source code of the Marp Editor
- GitHub Issues for reporting issues concerning the Marp Editor
- Docs for how to use the Marp Editor
- Contact for how to contact the developer of the Marp Editor
- Marp Editor To do List for the roadmap of the Marp Editor
- Standard Notes Slack for connecting with the Standard Notes Community
- Standard Notes Help for help with issues related to Standard Notes but unrelated to this editor