Skip to content

use ordered list start index when rendering #30

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

Merged
merged 2 commits into from
Dec 8, 2021

Conversation

QuietMisdreavus
Copy link
Contributor

@QuietMisdreavus QuietMisdreavus commented Dec 8, 2021

Bug/issue #, if applicable: rdar://73847907

Summary

While cmark-gfm saves the starting index of an ordered list, swift-markdown and Swift-DocC currently discards this information. This PR is part of a set that preserves the starting index when rendering documentation.

Dependencies

Testing

Build this branch, then follow the testing instructions on swiftlang/swift-docc#53.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran npm test, and it succeeded
  • [ n/a ] Updated documentation if necessary

@mportiz08
Copy link
Contributor

@swift-ci test

Copy link
Contributor

@mportiz08 mportiz08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change looks great, and I tested that it works end-end with some example content. 👍

@mportiz08
Copy link
Contributor

Going to go ahead and merge this since the change is ready and backwards compatible with existing JSON data.

@mportiz08 mportiz08 merged commit f5bce67 into swiftlang:main Dec 8, 2021
@QuietMisdreavus QuietMisdreavus deleted the list-numbering branch December 8, 2021 22:59
LebJe pushed a commit to LebJe/swift-docc-render that referenced this pull request Dec 18, 2021
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

Successfully merging this pull request may close these issues.

2 participants