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

135 feat cross linking select heading depths #136

Merged
merged 5 commits into from
Dec 21, 2020

Conversation

about-code
Copy link
Owner

Closes #135

@about-code about-code merged commit d4c8646 into master Dec 21, 2020
@about-code about-code deleted the 135-feat-cross-linking-select-heading-depths branch December 21, 2020 23:03
about-code added a commit that referenced this pull request Dec 24, 2020
`indexing.headingDepths` affects term-based link creation as well as path
resolution for existing links using heading ids to refer to a section in
another document. `linking.headingDepths` is the option to actually control
term-based link creation (effectively) based on previously indexed headings.

This commit only adds `indexing.headingDepths`. `linking.headingDepths` was
introduced in 95708c7 of PR #136.
about-code added a commit that referenced this pull request Dec 24, 2020
#139)

`indexing.headingDepths` affects path resolution for cross-links using custom heading ids 
to refer to a section in another document *but also provides indexing* for term-based link
creation. There should be rare cases for changing its default value. `linking.headingDepths`
in contrast is the option to actually control term-based auto link creation *based on indexed 
headings*. `indexing.headingDepths` by default covers the complete set of CommonMark
heading depths, that is, `[1,2,3,4,5,6]`. `linking.headingDepths` depends on headings being
indexed and therefore must always be a  complete _subset_ of `indexing.headingDepths`.
If headings at, e.g. depth 5 would not be indexed, then they could not be found for auto
linking, so even though `linking.headingDepths` might included 5, they were not auto linked.

This commit  adds `indexing.headingDepths` and modifies `linking.headingDepths` which was
introduced in 95708c7 of PR #136.

* test: New baseline.
* test: Test cases for 'indexing.headingDepth'
* test: Moved files.
* test: Reordered test-suite to run tests for basic functionality before tests
which are likely to depend on those functionality.
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.

Feat (Cross-Linking): Select heading depths to participate in linkification.
1 participant