Skip to content

Commit 00b1b51

Browse files
amyrlamgaearon
amyrlam
authored and
gaearon
committed
Initial setup of Docusaurus (#5227)
* Initial setup of Docusaurus Followed steps on: https://docusaurus.io/docs/en/installation * Delete doc1.md * Delete doc2.md * Delete doc3.md * Delete exampledoc4.md * Delete exampledoc5.md
1 parent 209053b commit 00b1b51

20 files changed

+6637
-0
lines changed

‎website/README.md

+193
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
This website was created with [Docusaurus](https://docusaurus.io/).
2+
3+
# What's In This Document
4+
5+
* [Get Started in 5 Minutes](#get-started-in-5-minutes)
6+
* [Directory Structure](#directory-structure)
7+
* [Editing Content](#editing-content)
8+
* [Adding Content](#adding-content)
9+
* [Full Documentation](#full-documentation)
10+
11+
# Get Started in 5 Minutes
12+
13+
1. Make sure all the dependencies for the website are installed:
14+
15+
```sh
16+
# Install dependencies
17+
$ yarn
18+
```
19+
2. Run your dev server:
20+
21+
```sh
22+
# Start the site
23+
$ yarn start
24+
```
25+
26+
## Directory Structure
27+
28+
Your project file structure should look something like this
29+
30+
```
31+
my-docusaurus/
32+
docs/
33+
doc-1.md
34+
doc-2.md
35+
doc-3.md
36+
website/
37+
blog/
38+
2016-3-11-oldest-post.md
39+
2017-10-24-newest-post.md
40+
core/
41+
node_modules/
42+
pages/
43+
static/
44+
css/
45+
img/
46+
package.json
47+
sidebar.json
48+
siteConfig.js
49+
```
50+
51+
# Editing Content
52+
53+
## Editing an existing docs page
54+
55+
Edit docs by navigating to `docs/` and editing the corresponding document:
56+
57+
`docs/doc-to-be-edited.md`
58+
59+
```markdown
60+
---
61+
id: page-needs-edit
62+
title: This Doc Needs To Be Edited
63+
---
64+
65+
Edit me...
66+
```
67+
68+
For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
69+
70+
## Editing an existing blog post
71+
72+
Edit blog posts by navigating to `website/blog` and editing the corresponding post:
73+
74+
`website/blog/post-to-be-edited.md`
75+
```markdown
76+
---
77+
id: post-needs-edit
78+
title: This Blog Post Needs To Be Edited
79+
---
80+
81+
Edit me...
82+
```
83+
84+
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
85+
86+
# Adding Content
87+
88+
## Adding a new docs page to an existing sidebar
89+
90+
1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
91+
92+
```md
93+
---
94+
id: newly-created-doc
95+
title: This Doc Needs To Be Edited
96+
---
97+
98+
My new content here..
99+
```
100+
101+
1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
102+
103+
```javascript
104+
// Add newly-created-doc to the Getting Started category of docs
105+
{
106+
"docs": {
107+
"Getting Started": [
108+
"quick-start",
109+
"newly-created-doc" // new doc here
110+
],
111+
...
112+
},
113+
...
114+
}
115+
```
116+
117+
For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
118+
119+
## Adding a new blog post
120+
121+
1. Make sure there is a header link to your blog in `website/siteConfig.js`:
122+
123+
`website/siteConfig.js`
124+
```javascript
125+
headerLinks: [
126+
...
127+
{ blog: true, label: 'Blog' },
128+
...
129+
]
130+
```
131+
132+
2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
133+
134+
`website/blog/2018-05-21-New-Blog-Post.md`
135+
136+
```markdown
137+
---
138+
author: Frank Li
139+
authorURL: https://twitter.com/foobarbaz
140+
authorFBID: 503283835
141+
title: New Blog Post
142+
---
143+
144+
Lorem Ipsum...
145+
```
146+
147+
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
148+
149+
## Adding items to your site's top navigation bar
150+
151+
1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
152+
153+
`website/siteConfig.js`
154+
```javascript
155+
{
156+
headerLinks: [
157+
...
158+
/* you can add docs */
159+
{ doc: 'my-examples', label: 'Examples' },
160+
/* you can add custom pages */
161+
{ page: 'help', label: 'Help' },
162+
/* you can add external links */
163+
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
164+
...
165+
],
166+
...
167+
}
168+
```
169+
170+
For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
171+
172+
## Adding custom pages
173+
174+
1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
175+
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
176+
177+
`website/siteConfig.js`
178+
```javascript
179+
{
180+
headerLinks: [
181+
...
182+
{ page: 'my-new-custom-page', label: 'My New Custom Page' },
183+
...
184+
],
185+
...
186+
}
187+
```
188+
189+
For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
190+
191+
# Full Documentation
192+
193+
Full documentation can be found on the [website](https://docusaurus.io/).

‎website/blog/2016-03-11-blog-post.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Blog Title
3+
author: Blog Author
4+
authorURL: http://twitter.com/
5+
authorFBID: 100002976521003
6+
---
7+
8+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien.
9+
10+
<!--truncate-->
11+
12+
Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut.
13+
14+
Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra.
15+
16+
Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum.
17+
18+
Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis.

‎website/blog/2017-04-10-blog-post-two.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: New Blog Post
3+
author: Blog Author
4+
authorURL: http://twitter.com/
5+
authorFBID: 100002976521003
6+
---
7+
8+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien.
9+
10+
<!--truncate-->
11+
12+
Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut.
13+
14+
Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra.
15+
16+
Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum.
17+
18+
Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis.

‎website/blog/2017-09-25-testing-rss.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Adding RSS Support - RSS Truncation Test
3+
author: Eric Nakagawa
4+
authorURL: http://twitter.com/ericnakagawa
5+
authorFBID: 661277173
6+
---
7+
1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
8+
9+
This should be truncated.
10+
<!--truncate-->
11+
This line should never render in XML.

‎website/blog/2017-09-26-adding-rss.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Adding RSS Support
3+
author: Eric Nakagawa
4+
authorURL: http://twitter.com/ericnakagawa
5+
authorFBID: 661277173
6+
---
7+
8+
This is a test post.
9+
10+
A whole bunch of other information.

‎website/blog/2017-10-24-new-version-1.0.0.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: New Version 1.0.0
3+
author: Eric Nakagawa
4+
authorURL: http://twitter.com/ericnakagawa
5+
authorFBID: 661277173
6+
---
7+
8+
This blog post will test file name parsing issues when periods are present.

‎website/core/Footer.js

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/**
2+
* Copyright (c) 2017-present, Facebook, Inc.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
8+
const React = require('react');
9+
10+
class Footer extends React.Component {
11+
docUrl(doc, language) {
12+
const baseUrl = this.props.config.baseUrl;
13+
return `${baseUrl}docs/${language ? `${language}/` : ''}${doc}`;
14+
}
15+
16+
pageUrl(doc, language) {
17+
const baseUrl = this.props.config.baseUrl;
18+
return baseUrl + (language ? `${language}/` : '') + doc;
19+
}
20+
21+
render() {
22+
return (
23+
<footer className="nav-footer" id="footer">
24+
<section className="sitemap">
25+
<a href={this.props.config.baseUrl} className="nav-home">
26+
{this.props.config.footerIcon && (
27+
<img
28+
src={this.props.config.baseUrl + this.props.config.footerIcon}
29+
alt={this.props.config.title}
30+
width="66"
31+
height="58"
32+
/>
33+
)}
34+
</a>
35+
<div>
36+
<h5>Docs</h5>
37+
<a href={this.docUrl('doc1.html', this.props.language)}>
38+
Getting Started (or other categories)
39+
</a>
40+
<a href={this.docUrl('doc2.html', this.props.language)}>
41+
Guides (or other categories)
42+
</a>
43+
<a href={this.docUrl('doc3.html', this.props.language)}>
44+
API Reference (or other categories)
45+
</a>
46+
</div>
47+
<div>
48+
<h5>Community</h5>
49+
<a href={this.pageUrl('users.html', this.props.language)}>
50+
User Showcase
51+
</a>
52+
<a
53+
href="http://stackoverflow.com/questions/tagged/"
54+
target="_blank"
55+
rel="noreferrer noopener">
56+
Stack Overflow
57+
</a>
58+
<a href="https://discordapp.com/">Project Chat</a>
59+
<a
60+
href="https://twitter.com/"
61+
target="_blank"
62+
rel="noreferrer noopener">
63+
Twitter
64+
</a>
65+
</div>
66+
<div>
67+
<h5>More</h5>
68+
<a href={`${this.props.config.baseUrl}blog`}>Blog</a>
69+
<a href="https://github.com/">GitHub</a>
70+
<a
71+
className="github-button"
72+
href={this.props.config.repoUrl}
73+
data-icon="octicon-star"
74+
data-count-href="/facebook/docusaurus/stargazers"
75+
data-show-count="true"
76+
data-count-aria-label="# stargazers on GitHub"
77+
aria-label="Star this project on GitHub">
78+
Star
79+
</a>
80+
</div>
81+
</section>
82+
83+
<a
84+
href="https://code.facebook.com/projects/"
85+
target="_blank"
86+
rel="noreferrer noopener"
87+
className="fbOpenSource">
88+
<img
89+
src={`${this.props.config.baseUrl}img/oss_logo.png`}
90+
alt="Facebook Open Source"
91+
width="170"
92+
height="45"
93+
/>
94+
</a>
95+
<section className="copyright">{this.props.config.copyright}</section>
96+
</footer>
97+
);
98+
}
99+
}
100+
101+
module.exports = Footer;

0 commit comments

Comments
 (0)