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

Document how to set options #34

Open
Nuru opened this issue Feb 14, 2022 · 0 comments
Open

Document how to set options #34

Nuru opened this issue Feb 14, 2022 · 0 comments

Comments

@Nuru
Copy link

Nuru commented Feb 14, 2022

The README documents a set of options to set, but not how to set them. Please document how to set the options or, if it is as simple as including them in the Kramdown options set, show an example.

Extra credit: show how to set options for the parser from Jekyll.

Proposal

Feel free to make these changes to the README, if they are correct, next time you update it (I do not want to submit a separate PR):

Usage:

require 'kramdown'
require 'kramdown-parser-gfm'

Kramdown::Document.new(text, input: 'GFM', gfm_quirks: ["no_auto_typographic"]).to_html

Using with Jekyll:
parser-gfm is the default in Jekyll. You do not need to specify input: "GFM" and you can pass options to it in the kramdown portion of your config file. For example:

kramdown:
   gfm_quirks: ["no_auto_typographic"]
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

1 participant