Conversation
|
|
|
@bdemers wanna rebase now? |
0670940 to
1bc710e
Compare
|
Performed by running `kramdoc README.md`, manual tweaks to follow in the next commit Excludes adoc files from license checks
a8b2a40 to
41c86e6
Compare
|
Rebased, (force pushed) |
lhazlewood
left a comment
There was a problem hiding this comment.
2 questions:
- Is this approach 'worth it' to you - i.e. do you feel it provides both a better authoring mechanism as well as reader/viewer experience?
- Will existing external links to our documentation still work correctly? I just thought if something references
https://github.com/jwkt/jjwt/README.md#some-anchor, everything like that would break, no?
|
|
||
| <a name="overview"></a> | ||
| ## What is a JSON Web Token? | ||
| +++<a name="overview">++++++</a>+++ |
There was a problem hiding this comment.
Does this mean that the anchor is still valid/retained? I'm not yet familiar with this type of adoc syntax.
There was a problem hiding this comment.
Yes, both the named and generated anchors should be the same
IMHO, it provides a better author experience, and it allows the version to be set with a property [in the header] (and could be automated at release times).
Yes, I made a pass through last week, running something like this (browser console), in both GitHub rendered versions (and diffed them): for (const a of document.anchors) {
if (a.name.startsWith('user-content-')) {
console.log(a.name.substring(13, a.name.length))
}
}It seems GitHub prefixes the named anchors with |
lhazlewood
left a comment
There was a problem hiding this comment.
Ok, thanks for the confirmation! Feel free to merge - I wouldn't want you to have to go through another big merge conflict again in the future. If we miss any small details now, we can always adjust them later.
To simplify the release process, we can migrate the README to adoc and use variables for things like the project version.
This should simplify release automation in the future.
NOTE: This PR should NOT be merged, but instead should be re-applied after JWE work is complete
Steps:
Install kramdown:
Convert README:
Add project version variable, and update code blocks:See b0f106a
NOTE: Code blocks are not filtered/interpolated by default, so the
subs="+attributes"directive must be addedTODO: