md-editor/README.md

61 lines
1.7 KiB
Markdown
Raw Normal View History

2023-03-20 21:52:44 +00:00
# MD Editor
A simple markdown editor with customizable styles.
## Available styles
- **Default.** A minimalistic and simple style based on [Markdown CV](https://git.sofiaritz.com/sofia/markdown-cv)'s
style.
- **Formal.** A minimalistic style that uses beautiful serif fonts everywhere, and with an elegant monospace font.
- **Insane.** _You a Comic Sans fan, huh?_
## Custom styles
> **Warning.** Feature is not fully implemented and stylesheets are subject to change!
### How to create a custom style
It is really simple to create a custom style. The styles that are bundled follow the following conventions:
- **Fonts.** Use the [`@import`](https://developer.mozilla.org/en-US/docs/Web/CSS/@import)
and [`@font-face`](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face) at-rule to import styles and to create
fonts.
- **Styling.** Just use HTML tags.
For example:
```css
* {
font-family: "Comic Sans MS", sans-serif;
}
p {
font-size: 100pt;
}
```
### How to use a custom style
(TBD; ?style={url}; add input and favourites)
## Features
- Auto-saving
- Export to PDF and HTML
- Download Markdown file
- Simple style selector
## To-Do
- [ ] Fully implement custom styles
- [ ] Support exporting
- [x] Support Markdown
- [x] Support HTML
- [x] Support PDF*
- [ ] Support ODT
- [ ] Support DOCX
- [ ] Support importing
- [x] Support Markdown
- [ ] Support HTML
- [ ] Support ODT
- [ ] Support DOC, DOCX
## Expectations
This project started because of my frustration finding a text-editor that used Markdown and was easily customizable.
I'm starting to use this for my projects and essays in high-school.
This means that changes will probably be frequent and _sometimes_ breaking (though I'll try to not make them often).