alexneri / asciiedit

A simple node.js app that lets you preview asciidoc code along with a WYSWYG Editor to edit your asciidoc code.

ASCII EDIT

Welcome to ASCIIEDIT!

ASCII Edit is a simple node.js app that lets you preview asciidoc code along with a WYSWYG Editor to change your asciidoc code.

The app features a code editor, which you can add your standard ASCIIDOC code.

This app features two regions:

• The Asciidoc editor where the asciidoc code is entered and edited.

• The Preview button. Click this will generate a preview of your asciidoc code in the preview box.

The Preview box will display a formatted preview of your asciidoc code from the Asciidoc editor box. This preview is editable. After completing your changes in the Preview box, click Save to save your changes back to the Asciidoc editor, where your changes in the Preview box will be reflected on the Asciidoc editor box.

Preview of the tool

You can see a preview of this tool and test it on my replit. Beware that this will reflect any change I have on the code and can be untested.

Bugs, comments, suggestions, and the like

If you have any suggestions to improve upon, file a ticket in the tracker. I will get to the roadmap whenever I feel like it (hehehe).

Contact

You can contact me via Misskey, Twitter, or via my website.

Relevant links

See my Linktree.

asciiedit's Issues

Payload too large error

If the contents of the editor and preview window are 'too large', the editor will not generate asciidoc code.

PayloadTooLargeError: request entity too large at readStream (/home/runner/asciiedit/node_modules/raw-body/index.js:156:17) at getRawBody (/home/runner/asciiedit/node_modules/raw-body/index.js:109:12) at read (/home/runner/asciiedit/node_modules/body-parser/lib/read.js:79:3) at textParser (/home/runner/asciiedit/node_modules/body-parser/lib/types/text.js:86:5) at Layer.handle [as handle_request] (/home/runner/asciiedit/node_modules/express/lib/router/layer.js:95:5) at next (/home/runner/asciiedit/node_modules/express/lib/router/route.js:144:13) at Route.dispatch (/home/runner/asciiedit/node_modules/express/lib/router/route.js:114:3) at Layer.handle [as handle_request] (/home/runner/asciiedit/node_modules/express/lib/router/layer.js:95:5) at /home/runner/asciiedit/node_modules/express/lib/router/index.js:284:15 at Function.process_params (/home/runner/asciiedit/node_modules/express/lib/router/index.js:346:12)

Editor buttons on the Preview editor window

Add some formatting and editor buttons for the Preview editor window. This includes some text formatting for the text editor, such as Bold, Italicize, Unordered list, Ordered list, Code, Anchor Link, etc.

Some ASCIIDOC Code will not re-render in the code editor after clicking Save to Code

The nature of this error is intermittent, and may be related to how asciidoc handles docbooks and headers.

The 'Save to Code' function tries to convert the existing text and styles into code, but sometimes header conflicts, such as expected header levels versus whether or not the target "file" is a docbook prevents the update from being saved into asciidoc code.

Related error message:

asciidoctor: ERROR: <stdin>: line 1514: level 0 sections can only be used when doctype is book asciidoctor: WARNING: <stdin>: line 1514: id assigned to section already in use: loans-web-journey-reference-retail asciidoctor: ERROR: <stdin>: line 3025: level 0 sections can only be used when doctype is book asciidoctor: WARNING: <stdin>: line 3025: id assigned to section already in use: loans-web-journey-reference-retail

Code lines in the Preview Editor do not translate into asciidoc code after clicking [Save to code]

This issue is where code formatted lines in the original asciidoc code is shown in the preview, edited in preview, and saved back to code.

Expected behavior

The code formatted lines are retained in the asciidoc code.

Current behavior

Code formatted lines lose their formatting, losing the style in the asiidoc code.

Github actions Setup

Github actions is not properly setup and needs to be configured for proper CI and testing