rascunho/README-en.md -rw-r--r-- 1.5 KiB
18234f8a — Pedro Lucas Porcellis Improve markdown blockquotes and code sections 8 months ago


A small project to preview markdown notes.

This project allows you to submit a text in the markdown format and preview the note, with no tracking and no ads. It will also generate a link so you can share the note around.

There's also a very basic API so you can create notes using a POST request to the endpoint at /api/v1.


The documentation about the ops is available at the repo rascunho-etc. There you'll find a openrc service and a nginx configuration.

There's a instance deployed at eletrotupi.com where is using PostgreSQL and being served with nginx, but you can use whatever kind of database compatible with SQLAlchemy like mysql or sqlite.


Install the dependencies using your distro package manager, namely sqlalchemy, flask, humanize, dateutil, mistune and serve with a reverse-proxy (like nginx).


There's is a pretty basic API, here's a sample using curl (1):

curl -X POST \
  'https://rascunho-instance.com/api/v1' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"text": "# This is a test.\n\n Hello **world**." }'


Send patches, start discussions and other things at my public-inbox.


Source code available under the GNU AGPL-3.0-or-later, check the LICENSE file to more info.