Skip to content

docs: fix anchor links in rendered specs #3200

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.

Sign up for GitHub

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 1 commit into from
Mar 16, 2023
Merged

docs: fix anchor links in rendered specs #3200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions scripts/md2html/md2html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ function preface(title,options) {
if (options.respec) {
preface += '<script src="../js/respec-oai.js" class="remove"></script>';
preface += `<script class="remove">var respecConfig = ${JSON.stringify(respec)};</script>`;
preface += fs.readFileSync('./analytics/google.html','utf8');
try {
preface += fs.readFileSync('./analytics/google.html','utf8');
}
catch (ex) {}
preface += '</head><body>';
preface += '<style>';
preface += '#respec-ui { visibility: hidden; }';
Expand Down Expand Up @@ -167,6 +170,7 @@ let indents = [0];
// process the markdown
for (let l in lines) {
let line = lines[l];
let linkTarget;

if (line.startsWith('## Table of Contents')) inTOC = true;
if (line.startsWith('<!-- /TOC')) inTOC = false;
Expand Down Expand Up @@ -213,7 +217,9 @@ for (let l in lines) {
let title = comp[1];
if (inDefs) title = '<dfn>'+title+'</dfn>';
let link = comp[0].split('<a ')[1].replace('name=','id=');
line = ('#'.repeat(newIndent)+' <span '+link+title+'</span>');
const anchor = link.split("'").join('"').split('"')[1];
line = '#'.repeat(newIndent)+' <span>'+title+'</span>';
linkTarget = '<a id="'+anchor+'"></a>';
}
else {
let title = line.split('# ')[1];
Expand Down Expand Up @@ -303,7 +309,7 @@ for (let l in lines) {
line = prefix+md.render(line);
}

lines[l] = line;
lines[l] = (linkTarget ? linkTarget : '') + line;
}

s = preface(`OpenAPI Specification v${argv.subtitle} | Introduction, Definitions, & More`,argv)+'\n\n'+lines.join('\n');
Expand Down