~porcellis/rascunho

Webservice to preview and share markdown notes

18234f8 Improve markdown blockquotes and code sections

16 days ago

598ecd4 Improve markdown blockquotes and code sections

16 days ago

#Rascunho

There's a english version of this README.

Um projeto para visualizar anotações usando o formato de texto markdown.

Esse projeto permite que você possa submeter um texto no formato markdown e pré-visualizar a anotação, sem anuncios, sem rastreamento. Também gera um link para que você possa compartilhar esse texto por aí.

Também temos uma API para que você possa criar esses rascunhos, basta fazer uma requisição POST em /api/v1.

#Infra

Documentação da infra está no repositório rascunho-etc, onde tem o arquivo de configuração do nginx e um serviço para o openrc.

A instância hospedada no eletrotupi.com está usando PostgreSQL e nginx, mas pode ser usado qualquer tipo de banco de dados compatível com o SQLAlchemy, de saida pode ser usado mysql e sqlite.

#Rodando

Instale as dependencias usando seu gerenciador de pacotes, sqlalchemy, humanize, flask, mistune, dateutil e sirva o projeto embaixo de um proxy reverso (recomendo o nginx).

#Usando a API

Existe uma API simples, aqui um exemplo usando curl (1):

curl -X POST \
  'https://instancia-do-rascunho/api/v1' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"text": "# Isso é um teste.\n\n Olá **mundo**." }'

#Contribuir

Mande patches, comece discussões e outras coisas na minha caixa de entrada pública, lembre-se de usar emails apenas texto.

#Licença

Utiliza a Licença GNU AGPL-3.0-or-later, veja o arquivo LICENSE para mais informações.