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

Documentation and/or example usage #17

Closed
adam-arold opened this issue Jan 20, 2017 · 4 comments
Closed

Documentation and/or example usage #17

adam-arold opened this issue Jan 20, 2017 · 4 comments
Assignees

Comments

@adam-arold
Copy link

The README is rather lacking in the details of how to use intellij-markdown. For example I can't tell whether I can use this to create an AST of a given markdown file which I can use for other purposes? The README links some files which does not look like an api and there is no reference to any programmatic api I can use.

@valich valich self-assigned this Jan 20, 2017
@valich
Copy link
Collaborator

valich commented Jan 20, 2017

Hi @adam-arold,

This is indeed an issue and I've made an attempt to add some of the most basic information on the usage and available extension API. Hope that answers your particular question. Have you any more questions or you think something is not clear please don't hesitate to ask for explanation or suggest your improvements.

@adam-arold
Copy link
Author

Perfect, thank you! I'll try this out tomorrow.

@adam-arold
Copy link
Author

Is this library used by IntelliJ (thus the name of the lib)?

@valich
Copy link
Collaborator

valich commented Jan 21, 2017

Yes, it's used as a parser and HTML generator for Markdown Support plugin.

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