Skip to content

doc, tools: improve the title of pages in doc #7939

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
yorkie wants to merge 2 commits into from
Closed

doc, tools: improve the title of pages in doc #7939

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f79b487
doctool: improve the title of pages in doc
yorkie Aug 1, 2016
7f14d39
doc: refine the doc title
yorkie Aug 2, 2016
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
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 @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>__SECTION__ Node.js __VERSION__ Manual &amp; Documentation</title>
<title>__SECTION__ | Node.js __VERSION__ Manual &amp; Documentation</title>
Copy link
Copy Markdown
Contributor

@silverwind silverwind Aug 2, 2016

Choose a reason for hiding this comment

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

Maybe drop the Manual &amp; while we're here? Long titles like this usually get truncated on tabs.

Copy link
Copy Markdown
Member

@jasnell jasnell Aug 2, 2016

Choose a reason for hiding this comment

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

+1

On Monday, August 1, 2016, silverwind [email protected] wrote:

In doc/template.html
#7939 (comment):

@@ -2,7 +2,7 @@

- <title>**SECTION** Node.js **VERSION** Manual & Documentation</title> - <title>**SECTION** | Node.js **VERSION** Manual & Documentation</title>

Maybe drop the Manual & while we're here? Long titles like this
usually get truncated on tabs.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/nodejs/node/pull/7939/files/f79b4872d33cb854f5fd5661f2762c0782b98415#r73095875,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAa2eV0M2XcFXDfNPfuDQiYrWkEvxB5Wks5qbtTHgaJpZM4JZ0aC
.

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic">
<link rel="stylesheet" href="assets/style.css">
<link rel="stylesheet" href="assets/sh.css">
Expand Down
2 changes: 1 addition & 1 deletion tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ function render(opts, cb) {

template = template.replace(/__ID__/g, id);
template = template.replace(/__FILENAME__/g, filename);
template = template.replace(/__SECTION__/g, section);
template = template.replace(/__SECTION__/g, section || 'Index');
Copy link
Copy Markdown
Contributor

@silverwind silverwind Aug 2, 2016

Choose a reason for hiding this comment

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

Could also use TOC here, just a suggestion.

Copy link
Copy Markdown
Contributor Author

@yorkie yorkie Aug 2, 2016

Choose a reason for hiding this comment

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

The reason that I did use "Index" is here, should we unify them? any thoughts @jasnell?

template = template.replace(/__VERSION__/g, nodeVersion);
template = template.replace(/__TOC__/g, toc);
template = template.replace(
Expand Down