https://github.com/terraphim/terraphim-editor
https://github.com/terraphim/terraphim-editor
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/terraphim/terraphim-editor
- Owner: terraphim
- License: mit
- Created: 2025-10-23T16:38:21.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-11-15T22:03:22.000Z (8 months ago)
- Last Synced: 2025-12-26T11:14:58.988Z (6 months ago)
- Language: JavaScript
- Size: 1.39 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraphim Editor
A WebAssembly-based Markdown editor built with Rust, [Shoelace](https://shoelace.style/) styles and no other dependencies.
Trunk is used for the build system
## Features
- Live Markdown preview
- Pure Javascript for front end and WebAssembly implementation for rendering Markdown
- Minimal external dependencies
- Modern web components UI
## Prerequisites
1. Install Rust:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Add the WebAssembly target:
```bash
rustup target add wasm32-unknown-unknown
```
3. Install Trunk:
```bash
cargo install trunk
```
## Development
Run the development server:
```bash
trunk serve
```
Visit `http://127.0.0.1:8080` in your browser.
## Testing
### Rust Tests
Run the Rust unit tests:
```bash
cargo test
```
### Frontend Tests (Wasm)
Run the frontend tests:
```bash
wasm-pack test --chrome
```
## Building for Production
Create a production build:
```bash
trunk build --release
```
The output will be in the `dist` directory.
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.