memoroux

by naduma

GitHub Readme.md

memoroux

This is a personal online AsciiDoc converter/editor using Asciidoctor.

Setup

  1. Sign up to Heroku and log in to your account.

  2. Click the button below and follow the instructions.

Deploy

Usage

  • Access to created site, and use.

  • Use the API through your favorite editor.

Specification

Name Version

ruby

2.5.3

asciidoctor

1.5.8

asciidoctor-diagram

1.5.13

asciidoctor-pdf

1.5.0.alpha.16

asciidoctor-pdf-cjk

0.1.3

coderay

1.1.2

supported extensions Diagram Type gif pdf png svg txt

ditaa

☑️

☑️

graphviz

☑️

☑️

☑️

plantuml

☑️

☑️

☑️

Configuration

Basic Authentication

If you wish, you can set up authentication on the site. To enable basic authentication, set "Config Vars" on heroku.

Set both USERNAME and PASSWORD.

$ heroku config:set USERNAME=xxx
$ heroku config:set PASSWORD=xxx

API

Convert

Convert and generate html file and image file.

Request

POST /convert
Content-Type: application/json
Name Type Required Description

id

string

☑️

Unique ID [a-zA-Z0-9-]

type

string

☑️

Conversion type (html or pdf)

content

string

☑️

Content

Response

Content-Type: application/json
Name Type Description

url

string

converted url path