md-editor/README.md
2023-03-20 22:52:44 +01:00

1.7 KiB

MD Editor

A simple markdown editor with customizable styles.

Available styles

  • Default. A minimalistic and simple style based on 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 and @font-face at-rule to import styles and to create fonts.
  • Styling. Just use HTML tags.

For example:

* {
    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
    • Support Markdown
    • Support HTML
    • Support PDF*
    • Support ODT
    • Support DOCX
  • Support importing
    • 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).