Skip to content

doc: add links to alternative versions of doc #10958

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

Closed
chris--young wants to merge 10 commits into from
Closed

doc: add links to alternative versions of doc #10958

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1d10887
doc: add links to alternative versions of doc
Jan 23, 2017
c21e62b
doc: fixes version labeling of alt doc links
Jan 24, 2017
0e35692
doc: removes redudant if from version labels
Jan 28, 2017
e161b83
doc: renamed 'doc_created' comment tags
Mar 4, 2017
334ff51
doc: corrected api doc dates for crypto & debugger
May 9, 2017
4d7fd63
doc: updated links so version 8 is latest
Jul 17, 2017
cb4622f
doc: moved version links into a dropdown
Jul 23, 2017
d01c036
doc: addressed misc review comments
Aug 26, 2017
967cdba
doc: use better regex
Aug 26, 2017
6e113e2
doc: made version links fit in mobile view size
Aug 28, 2017
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
Prev Previous commit
Next Next commit
doc: addressed misc review comments 
Fixes: #10726
  • Loading branch information
Chris Young committed Aug 26, 2017
commit d01c036aeb382b46bf322bd8203e7feb8e8b4485
2 changes: 1 addition & 1 deletion doc/api/addons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!--introduced_in=v0.10.0-->

Node.js Addons are dynamically-linked shared objects, written in C or C++, that
Node.js Addons are dynamically-linked shared objects, written in C++, that
can be loaded into Node.js using the [`require()`][require] function, and used
just as if they were an ordinary Node.js module. They are used primarily to
provide an interface between JavaScript running in Node.js and C/C++ libraries.
Expand Down
2 changes: 1 addition & 1 deletion doc/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1>Node.js __VERSION__ Documentation</h1>
<a href="__FILENAME__.json">View as JSON</a> |
</li>
<li class="version-picker">
<a href="#">View another version <span>&#x25bc</span></a>
<a href="#">View another version <span>&#x25bc;</span></a>
__ALTDOCS__
</li>
</ul>
Expand Down
11 changes: 6 additions & 5 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const typeParser = require('./type-parser.js');
module.exports = toHTML;

const STABILITY_TEXT_REG_EXP = /(.*:)\s*(\d)([\s\S]*)/;
const DOC_CREATED_REG_EXP = /<!--introduced_in=v([0-9]+).([0-9]+).([0-9]+)-->/;
const DOC_CREATED_REG_EXP = /<!--introduced_in( )?=( )?v([0-9]+)\.([0-9]+)\.([0-9]+)-->/;
Copy link
Copy Markdown
Contributor

@thefourtheye thefourtheye Aug 26, 2017

Choose a reason for hiding this comment

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

I was thinking more like

const DOC_CREATED_REG_EXP = /<!--\s*introduced_in\s*=\s*v([0-9]+)\.([0-9]+)\.([0-9]+)\s*-->/;


// customized heading without id attribute
const renderer = new marked.Renderer();
Expand Down Expand Up @@ -199,16 +199,17 @@ function altDocs(filename) {
let html = '';

if (!docCreated) {
console.error('Failed to add alternative version links');
console.error(`Failed to add alternative version links to ${filename}`);
return html;
}

function lte(v) {
Copy link
Copy Markdown
Contributor

@thefourtheye thefourtheye Aug 26, 2017

Choose a reason for hiding this comment

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

String based comparison with v.num is not good enough. Why not split it at dots and the do integer comparison?

if (docCreated[1] > v.num[0])
const ns = v.num.split('.');
if (docCreated[1] > +ns[0])
return false;
if (docCreated[1] < v.num[0])
if (docCreated[1] < +ns[0])
return true;
return docCreated[2] <= v.num.substr(2, 2);
return docCreated[2] <= +ns[1];
}

const versions = [
Expand Down