Automatically derive titles from md docs #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BillyONeal
reviewed
Aug 3, 2021
en/docs/README.html
Outdated
| <a class="doc-outline-link" href="/en/docs/about/faq.html"><li class="list-can-expand">faq</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/about/privacy.html"><li class="list-can-expand">privacy</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/about/faq.html"><li class="list-can-expand">Frequently Asked Questions</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/about/privacy.html"><li class="list-can-expand">Vcpkg telemetry and privacy</li></a> |
There was a problem hiding this comment.
Suggested change
| <a class="doc-outline-link" href="/en/docs/about/privacy.html"><li class="list-can-expand">Vcpkg telemetry and privacy</li></a> | |
| <a class="doc-outline-link" href="/en/docs/about/privacy.html"><li class="list-can-expand">vcpkg Telemetry and Privacy</li></a> |
en/docs/README.html
Outdated
| <a class="doc-outline-link" href="/en/docs/examples/modify-baseline-to-pin-old-boost.html"><li class="list-can-expand">Pin old Boost versions</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/overlay-triplets-linux-dynamic.html"><li class="list-can-expand">Overlay triplets example</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/packaging-github-repos.html"><li class="list-can-expand">Packaging Github Repos Example: libogg</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/packaging-zipfiles.html"><li class="list-can-expand">Packaging Zipfiles Example: zlib</li></a> |
There was a problem hiding this comment.
Suggested change
| <a class="doc-outline-link" href="/en/docs/examples/packaging-zipfiles.html"><li class="list-can-expand">Packaging Zipfiles Example: zlib</li></a> | |
| <a class="doc-outline-link" href="/en/docs/examples/packaging-zipfiles.html"><li class="list-can-expand">Packaging .zip Files Example: zlib</li></a> |
| <a class="doc-outline-link" href="/en/docs/examples/overlay-triplets-linux-dynamic.html"><li class="list-can-expand">Overlay triplets example</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/packaging-github-repos.html"><li class="list-can-expand">Packaging Github Repos Example: libogg</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/packaging-zipfiles.html"><li class="list-can-expand">Packaging Zipfiles Example: zlib</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/examples/patching.html"><li class="list-can-expand">Patching Example: Patching libpng to work for x64-uwp</li></a> |
There was a problem hiding this comment.
Suggested change
| <a class="doc-outline-link" href="/en/docs/examples/patching.html"><li class="list-can-expand">Patching Example: Patching libpng to work for x64-uwp</li></a> | |
| <a class="doc-outline-link" href="/en/docs/examples/patching.html"><li class="list-can-expand">Patching Example: Patching libpng for x64-uwp</li></a> |
en/docs/README.html
Outdated
| <a class="doc-outline-link" href="/en/docs/users/manifests.html"><li class="list-can-expand">Manifest Mode</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/mingw.html"><li class="list-can-expand">Vcpkg and Mingw-w64</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/registries.html"><li class="list-can-expand">Using Registries</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/selecting-library-features.html"><li class="list-can-expand">Selecting library features</li></a> |
There was a problem hiding this comment.
Suggested change
| <a class="doc-outline-link" href="/en/docs/users/selecting-library-features.html"><li class="list-can-expand">Selecting library features</li></a> | |
| <a class="doc-outline-link" href="/en/docs/users/selecting-library-features.html"><li class="list-can-expand">Selecting Library Features</li></a> |
en/docs/README.html
Outdated
| <a class="doc-outline-link" href="/en/docs/users/mingw.html"><li class="list-can-expand">Vcpkg and Mingw-w64</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/registries.html"><li class="list-can-expand">Using Registries</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/selecting-library-features.html"><li class="list-can-expand">Selecting library features</li></a> | ||
| <a class="doc-outline-link" href="/en/docs/users/triplets.html"><li class="list-can-expand">Triplet files</li></a> |
There was a problem hiding this comment.
Suggested change
| <a class="doc-outline-link" href="/en/docs/users/triplets.html"><li class="list-can-expand">Triplet files</li></a> | |
| <a class="doc-outline-link" href="/en/docs/users/triplets.html"><li class="list-can-expand">Triplet Files</li></a> |
|
That is the intent of my PR, yes. The markdown documents should serve as the source of truth for those kinds of things. When we add new doc files, we should be able to simply and directly regenerate the html with no tweaking on this side. |
BillyONeal
added a commit
to BillyONeal/vcpkg
that referenced
this pull request
Aug 3, 2021
|
Can you apply microsoft/vcpkg#19345 and then rerun your script? |
BillyONeal
added a commit
to microsoft/vcpkg
that referenced
this pull request
Aug 3, 2021
BillyONeal
approved these changes
Aug 3, 2021
There was a problem hiding this comment.
Please rerun your script to pick up changes from microsoft/vcpkg#19345
strega-nil-ms
approved these changes
Aug 3, 2021
Sungeun0318
pushed a commit
to Sungeun0318/-vcpkg
that referenced
this pull request
May 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR derives nav titles based on the first line of the markdown doc under translation, assuming it matches
^#* (.*)$.