-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Update advanced usage docs #1244
Conversation
@joshbruce @UziTech @davisjam I'm thinking of adding 2 additional columns to the options table:
Do you think that's a good idea? |
tl;dr: Not a fall of the sword for me. Just some things to consider. I definitely think having |
docs/USING_ADVANCED.md
Outdated
@@ -41,18 +41,18 @@ console.log(myMarked('I am using __markdown__.')); | |||
|
|||
|Member |Type |Notes | | |||
|:-----------|:---------|:----------------------------------------------------------------------------------------------------------------------------| | |||
|baseUrl |`??` |Default is `null` | | |||
|baseUrl |`string` |A prefix url for any relative link. Default is `null` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we add the columns, think the order would be:
|Member |Type |Default |Added in |Notes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I went with Since
and put v0.4.0
so its clear that its clear that this is a version number. I couldn't easily find when these other features were introduced so I used ???
I don't understand this reservation. What would get out of sync?
I like the idea of deprecating too if we ever reach that point. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@joshbruce Any opposition here? |
Update advanced usage docs
Description
This adds a couple missing option types to the docs and also shows the version introduced for
headerIds
.Contributor
Committer
In most cases, this should be a different person than the contributor.