Skip to content

Commit

Permalink
remove .html from urls (#113)
Browse files Browse the repository at this point in the history 
* remove .html from urls

* broken internal link error - fix

* convert .html limiting to getting-started and packages href attribute values only
  • Loading branch information
@Sreenivas-Kalluru
Sreenivas-Kalluru authored Jun 30, 2023
1 parent 5a09eb8 commit a6a29fb
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 35 deletions.
14 changes: 7 additions & 7 deletions en/getting-started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@
<div class="collapse navbar-collapse align-items-center nav-vcpkg-bar" id="navbarResponsive">
<ul class="navbar-nav ml-auto navbar-right-margin">
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/getting-started.html">Get Started </a>
<a class="nav-link nav-link-hover" href="/en/getting-started">Get Started </a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/packages.html">Packages</a>
<a class="nav-link nav-link-hover" href="/en/packages">Packages</a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="https://learn.microsoft.com/vcpkg">Documentation</a>
Expand All @@ -91,10 +91,10 @@
<div class="mobile-margin">
<ul class="mobile-nav-list">
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/getting-started.html">Get Started</a>
<a class="navbar-mobile" href="/en/getting-started">Get Started</a>
</li>
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/packages.html">Packages</a>
<a class="navbar-mobile" href="/en/packages">Packages</a>
</li>
<li class="mobile-nav-item"><a class="navbar-mobile" href="/en/docs/README.html">Documentation</a></li>
<li class="mobile-nav-item">
Expand Down Expand Up @@ -371,17 +371,17 @@
<div class="footer-description">
<a
class="footer-link"
href="/en/getting-started.html?platform=windows"
href="/en/getting-started?platform=windows"
>Windows</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=linux"
<a class="footer-link" href="/en/getting-started?platform=linux"
>Linux</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=mac"
<a class="footer-link" href="/en/getting-started?platform=mac"
>Mac</a
>
</div>
Expand Down
18 changes: 9 additions & 9 deletions en/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@
<div class="collapse navbar-collapse align-items-center nav-vcpkg-bar" id="navbarResponsive">
<ul class="navbar-nav ml-auto navbar-right-margin">
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/getting-started.html">Get Started </a>
<a class="nav-link nav-link-hover" href="/en/getting-started">Get Started </a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/packages.html">Packages</a>
<a class="nav-link nav-link-hover" href="/en/packages">Packages</a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="https://learn.microsoft.com/vcpkg">Documentation</a>
Expand All @@ -93,10 +93,10 @@
<div class="mobile-margin">
<ul class="mobile-nav-list">
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/getting-started.html">Get Started</a>
<a class="navbar-mobile" href="/en/getting-started">Get Started</a>
</li>
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/packages.html">Packages</a>
<a class="navbar-mobile" href="/en/packages">Packages</a>
</li>
<li class="mobile-nav-item"><a class="navbar-mobile" href="/en/docs/README.html">Documentation</a></li>
<li class="mobile-nav-item">
Expand Down Expand Up @@ -211,11 +211,11 @@
<p><span>For all platforms, buildsystems, and workflows</span></p>
</div>

<a role="button" class="btn-lg vcpkg-btn-left text-nowrap" href="getting-started.html"
<a role="button" class="btn-lg vcpkg-btn-left text-nowrap" href="getting-started"
>Get started</a
>

<a role="button" class="btn-lg vcpkg-btn-right text-nowrap" href="packages.html"
<a role="button" class="btn-lg vcpkg-btn-right text-nowrap" href="packages"
>Browse Packages</a
>
</div>
Expand Down Expand Up @@ -301,17 +301,17 @@
<div class="footer-description">
<a
class="footer-link"
href="/en/getting-started.html?platform=windows"
href="/en/getting-started?platform=windows"
>Windows</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=linux"
<a class="footer-link" href="/en/getting-started?platform=linux"
>Linux</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=mac"
<a class="footer-link" href="/en/getting-started?platform=mac"
>Mac</a
>
</div>
Expand Down
14 changes: 7 additions & 7 deletions en/packages.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@
<div class="collapse navbar-collapse align-items-center nav-vcpkg-bar" id="navbarResponsive">
<ul class="navbar-nav ml-auto navbar-right-margin">
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/getting-started.html">Get Started </a>
<a class="nav-link nav-link-hover" href="/en/getting-started">Get Started </a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/packages.html">Packages</a>
<a class="nav-link nav-link-hover" href="/en/packages">Packages</a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="https://learn.microsoft.com/vcpkg">Documentation</a>
Expand All @@ -97,10 +97,10 @@
<div class="mobile-margin">
<ul class="mobile-nav-list">
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/getting-started.html">Get Started</a>
<a class="navbar-mobile" href="/en/getting-started">Get Started</a>
</li>
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/packages.html">Packages</a>
<a class="navbar-mobile" href="/en/packages">Packages</a>
</li>
<li class="mobile-nav-item"><a class="navbar-mobile" href="/en/docs/README.html">Documentation</a></li>
<li class="mobile-nav-item">
Expand Down Expand Up @@ -247,17 +247,17 @@
<div class="footer-description">
<a
class="footer-link"
href="/en/getting-started.html?platform=windows"
href="/en/getting-started?platform=windows"
>Windows</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=linux"
<a class="footer-link" href="/en/getting-started?platform=linux"
>Linux</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=mac"
<a class="footer-link" href="/en/getting-started?platform=mac"
>Mac</a
>
</div>
Expand Down
22 changes: 19 additions & 3 deletions scripts/validateLinks.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,18 @@ async function get_pages_recursive(docs_set, path) {
async function load_page_info(page, relative_path) {
/** @type {PageInfo} */
const ret = { links: [], fragments: {}, errors: [] };
var subUrls = ['getting-started', 'packages'];
const content = await fs.readFile(page, 'utf-8');
for (const match of content.matchAll(/ href="([^"?#]*)(#([^"?]*))?([^"]*)?"/g)) {
if (match[1].length == 0) {
if (match[3].length > 0) {
// reference to self anchor
ret.links.push([relative_path, match[3]]);
if (!relative_path.endsWith(".html") && subUrls.some(subUrl => relative_path.includes(subUrl))) {
ret.links.push([relative_path + ".html", match[3]]);
}
else {
ret.links.push([relative_path, match[3]]);
}
}
continue;
}
Expand All @@ -59,15 +65,25 @@ async function load_page_info(page, relative_path) {
if (match[1].startsWith("/css") || match[1].startsWith("/assets")) continue;
if (match[1].startsWith("/")) {
// Link is already relative to doc root
ret.links.push([match[1], match[3]]);
if (!match[1].endsWith(".html") && subUrls.some(subUrl => match[1].includes(subUrl))) {
ret.links.push([match[1] + ".html", match[3]]);
}
else {
ret.links.push([match[1], match[3]]);
}
} else {
var dir = dirname(relative_path);
var subpath = match[1];
while (subpath.startsWith("../")) {
dir = dirname(dir);
subpath = subpath.substring(3);
}
ret.links.push([dir + "/" + subpath, match[3]]);
if (!subpath.endsWith(".html") && subUrls.some(subUrl => subpath.includes(subUrl))) {
ret.links.push([dir + "/" + subpath + ".html", match[3]]);
}
else {
ret.links.push([dir + "/" + subpath, match[3]]);
}
}
}
for (const match of content.matchAll(/ id="([^"]*)"/g)) {
Expand Down
6 changes: 3 additions & 3 deletions templates/footer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@
<div class="footer-description">
<a
class="footer-link"
href="/en/getting-started.html?platform=windows"
href="/en/getting-started?platform=windows"
>Windows</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=linux"
<a class="footer-link" href="/en/getting-started?platform=linux"
>Linux</a
>
</div>
<div class="footer-description">
<a class="footer-link" href="/en/getting-started.html?platform=mac"
<a class="footer-link" href="/en/getting-started?platform=mac"
>Mac</a
>
</div>
Expand Down
4 changes: 2 additions & 2 deletions templates/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@
<p><span>For all platforms, buildsystems, and workflows</span></p>
</div>

<a role="button" class="btn-lg vcpkg-btn-left text-nowrap" href="getting-started.html"
<a role="button" class="btn-lg vcpkg-btn-left text-nowrap" href="getting-started"
>Get started</a
>

<a role="button" class="btn-lg vcpkg-btn-right text-nowrap" href="packages.html"
<a role="button" class="btn-lg vcpkg-btn-right text-nowrap" href="packages"
>Browse Packages</a
>
</div>
Expand Down
8 changes: 4 additions & 4 deletions templates/navbar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
<div class="collapse navbar-collapse align-items-center nav-vcpkg-bar" id="navbarResponsive">
<ul class="navbar-nav ml-auto navbar-right-margin">
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/getting-started.html">Get Started </a>
<a class="nav-link nav-link-hover" href="/en/getting-started">Get Started </a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="/en/packages.html">Packages</a>
<a class="nav-link nav-link-hover" href="/en/packages">Packages</a>
</li>
<li class="nav-item active" onmouseover="addMouseLeave()">
<a class="nav-link nav-link-hover" href="https://learn.microsoft.com/vcpkg">Documentation</a>
Expand All @@ -37,10 +37,10 @@
<div class="mobile-margin">
<ul class="mobile-nav-list">
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/getting-started.html">Get Started</a>
<a class="navbar-mobile" href="/en/getting-started">Get Started</a>
</li>
<li class="mobile-nav-item">
<a class="navbar-mobile" href="/en/packages.html">Packages</a>
<a class="navbar-mobile" href="/en/packages">Packages</a>
</li>
<li class="mobile-nav-item"><a class="navbar-mobile" href="/en/docs/README.html">Documentation</a></li>
<li class="mobile-nav-item">
Expand Down

0 comments on commit a6a29fb

Please sign in to comment.