-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added relevant information in the Readme.
- Loading branch information
Showing
1 changed file
with
26 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,30 @@ | ||
# 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 edit your asciidoc code. | ||
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. Clicking Preview will | ||
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](https://asciiedit.alexneri.repl.co/). 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 our tracker. I will get to the roadmap whenever I feel like it (hehehe). | ||
|
||
## Contact | ||
|
||
You can contact me via [Twitter](https://twitter.com/crosse_) or via [my website](https://sei.moe/contact). | ||
|
||
## Relevant links | ||
|
||
See [my Linktree](https://linktr.ee/crosse). |