Skip to content

Add "Edit on GitHub" link on normal docs pages #5454

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
wants to merge 1 commit into from
Closed

Add "Edit on GitHub" link on normal docs pages #5454

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
9 changes: 8 additions & 1 deletion website/layout/DocsLayout.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@ var DocsLayout = React.createClass({
<DocsSidebar metadata={metadata} />
<div className="inner-content">
<a id="content" />
<h1>{metadata.title}</h1>
<h1>
{metadata.title}
<a
className="edit-github"
href={'https://github.com/facebook/react-native/blob/master/docs/' + metadata.filename}>
Edit on GitHub
</a>
</h1>
<Marked>{content}</Marked>
<div className="docs-prevnext">
{metadata.previous && <a className="docs-prev" href={metadata.previous + '.html#content'}>&larr; Prev</a>}
Expand Down
10 changes: 7 additions & 3 deletions website/server/convert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function execute() {
files: [],
};

function handleMarkdown(content) {
function handleMarkdown(content, filename) {
var metadata = {};

// Extract markdown metadata header
Expand All @@ -78,6 +78,8 @@ function execute() {
return;
}

metadata.filename = filename;

// Create a dummy .js version that just calls the associated layout
var layout = metadata.layout[0].toUpperCase() + metadata.layout.substr(1) + 'Layout';

Expand Down Expand Up @@ -105,14 +107,16 @@ function execute() {
fs.writeFileSync(targetFile, content);
}

extractDocs().forEach(handleMarkdown);
extractDocs().forEach(function(content) {
handleMarkdown(content, null);
});

var files = glob.sync(MD_DIR + '**/*.*');
files.forEach(function(file) {
var extension = path.extname(file);
if (extension === '.md' || extension === '.markdown') {
var content = fs.readFileSync(file, {encoding: 'utf8'});
handleMarkdown(content);
handleMarkdown(content, path.basename(file));
}

if (extension === '.json') {
Expand Down