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.

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

doc: Highlight deprecated API components in "Table of Contents" #7189

Closed
wants to merge 1 commit into from
Closed

doc: Highlight deprecated API components in "Table of Contents" #7189

Show file tree
Hide file tree
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
15 changes: 15 additions & 0 deletions doc/api_assets/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,21 @@ hr {
margin-top: .666em;
}

#toc .stability_0::after {
background-color: #d50027;
color: #fff;
}

#toc .stability_0::after {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be better as ::before. Domains and Punycode formats poorly with the current:

(There may be some other way if resoling it that I am forgetting though.)

screen shot 2016-09-06 at 11 05 56 am

screen shot 2016-09-06 at 11 06 03 am

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be better as ::before

This cannot help with current realization :(
Pseudo-element attaches for list item's child (tag <a>) and cannot influence to somethings. I will try to find other solution in days

content: "deprecated";
font-size: .8em;
position: relative;
top: -.18em;
left: .5em;
padding: 0 .3em .2em;
border-radius: 3px;
}

#apicontent li {
margin-bottom: .5em;
}
Expand Down
26 changes: 22 additions & 4 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ const typeParser = require('./type-parser.js');

module.exports = toHTML;

const STABILITY_TEXT_REG_EXP = /(.*:)\s(\d)([\s\S]*)/;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to make the \s greedy, which is before the digits?


// customized heading without id attribute
var renderer = new marked.Renderer();
renderer.heading = function(text, level) {
Expand Down Expand Up @@ -153,8 +155,11 @@ function parseLists(input) {
var savedState = [];
var depth = 0;
var output = [];
let headingIndex = -1;
let heading = null;

output.links = input.links;
input.forEach(function(tok) {
input.forEach(function(tok, index) {
if (tok.type === 'blockquote_start') {
savedState.push(state);
state = 'MAYBE_STABILITY_BQ';
Expand All @@ -167,6 +172,17 @@ function parseLists(input) {
if ((tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') ||
tok.type === 'code') {
if (tok.text.match(/Stability:.*/g)) {
const stabilityMatch = tok.text.match(STABILITY_TEXT_REG_EXP);
const stability = +stabilityMatch[2];
Copy link
Contributor

@silverwind silverwind Oct 12, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Number(stabilityMatch[2]) might be cleaner.

const isStabilityIndex =
index - 2 === headingIndex || // general
index - 3 === headingIndex; // with api_metadata block

if (heading && isStabilityIndex) {
heading.stability = stability;
headingIndex = -1;
heading = null;
}
tok.text = parseAPIHeader(tok.text);
output.push({ type: 'html', text: tok.text });
return;
Expand All @@ -178,6 +194,8 @@ function parseLists(input) {
if (state === null ||
(state === 'AFTERHEADING' && tok.type === 'heading')) {
if (tok.type === 'heading') {
headingIndex = index;
heading = tok;
state = 'AFTERHEADING';
}
output.push(tok);
Expand Down Expand Up @@ -280,7 +298,7 @@ function linkJsTypeDocs(text) {

function parseAPIHeader(text) {
text = text.replace(
/(.*:)\s(\d)([\s\S]*)/,
STABILITY_TEXT_REG_EXP,
'<pre class="api_stability api_stability_$2">$1 $2$3</pre>'
);
return text;
Expand Down Expand Up @@ -324,8 +342,8 @@ function buildToc(lexed, filename, cb) {
const realFilename = path.basename(realFilenames[0], '.md');
const id = getId(realFilename + '_' + tok.text.trim());
toc.push(new Array((depth - 1) * 2 + 1).join(' ') +
'* <a href="#' + id + '">' +
tok.text + '</a>');
'* <span class="stability_' + tok.stability + '">' +
'<a href="#' + id + '">' + tok.text + '</a></span>');
tok.text += '<span><a class="mark" href="#' + id + '" ' +
'id="' + id + '">#</a></span>';
});
Expand Down