A lightweight WYSIWYG markdown editor, derivated from Milkdown editor
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 markdown-visualto 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:8001. 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
npm install -g http-serverthen run
http-server . -p 8080 --corsto serve the root directory at http://localhost:8080.
- To build the app, run
- Install the editor into the web or desktop app with
http://localhost:8080/sample.ext.jsonor with your custom
ctrl/cmd + Cto shut down the server.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:8001 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.