Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Markdown rendering component #348

Closed
Groostav opened this issue Aug 22, 2016 · 1 comment
Closed

add Markdown rendering component #348

Groostav opened this issue Aug 22, 2016 · 1 comment

Comments

@Groostav
Copy link

Groostav commented Aug 22, 2016

As a software developer using javaFX, I want an entirely textual way to represent large text documents, so that I may easily create things like in-application "help", "about", and other text-heavy content.

So, the Text, TextFlow, TextField, and etc objects really aren't tailored to creating long running text content. If you spend a great deal of time with these objects, using custom CSS and associated style classes I'd be willing to bet you could come up with something that looks as good as this issue does on github. But I wrote this issue on github with all its associated block-quotes, mono-space things, etc in less than 10 minutes, and generating that same component using the aforementioned javafx components would take an order of magnitude more time.

So I want Markdown in javafx, I am aware of MarkdownWriterFX, but I don't want to have to boot a web rendering component (includes nashorn?) to do it, and I want things like [mailto: links](mailto: [email protected]) to work (--which cant be done using the above markdown component without annoying hacks)

Now, given some of the (ongoing) work on AnTextFX, I think all of the in-paragraph highlighting features can be done very easily with ANTLR and RichTextFX. The multi paragraph features, such as indentation changes, list-views, etc may be more difficult. This also doesn't include support for tables, which I see as a nice to have but not a necessity for this component to deliver some level of value.

Specifically, I would like to deploy an application with something like the following:

<!-- content view.fxml -->

<VBox fx:controller="com.mycompany.ContentController">
  <children>
    <RichTextFXMarkdown content="/com/mycompany/content.md"/>
  </children>
</VBox>
#content.md
--

#About OurProject

OurProject is the _best_ project on the face of the earth. It solves all your problems! Everything is better when you purchase OurProject, including your ability to do things like write issues on [github](github.com).

Please contact [[email protected]](mailto:[email protected]) with any questions. Remember, most bugs are actually features, so only send us email if you're certain you've actually got a bug!

And remember, [looking for bugs in our software constitutes a violation of our license agreement and is tantamount to a federal crime!](https://www.scribd.com/doc/274176394/No-You-Really-Can-t-Mary-Ann-Davidson-Blog)

Would anybody else be interested in such a component?

tl;dr Implement custom markdown rendering component using a parser and RichTextFX. New repo? Does anybody else care to join me?

@JordanMartinez
Copy link
Contributor

Closing due to being outside the scope of this project. I've also written an explanation of what "out of the scope of this project" means in the wiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants