forked from reduxjs/react-redux
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
reduxjs#1031 Set up basic docusaurus structure (reduxjs#1032)
* reduxjs#1031 Set up basic docusaurus structure * Removed docker related files * Added metadata to the doc files * Code review: Moved docusaurus website to the top level of the repo and updated values in siteConfig.js according to comments by @markerikson
- Loading branch information
1 parent
35e517f
commit a9448ac
Showing
13 changed files
with
548 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| This website was created with [Docusaurus](https://docusaurus.io/). | ||
|
|
||
| # What's In This Document | ||
|
|
||
| * [Get Started in 5 Minutes](#get-started-in-5-minutes) | ||
| * [Directory Structure](#directory-structure) | ||
| * [Editing Content](#editing-content) | ||
| * [Adding Content](#adding-content) | ||
| * [Full Documentation](#full-documentation) | ||
|
|
||
| # Get Started in 5 Minutes | ||
|
|
||
| 1. Make sure all the dependencies for the website are installed: | ||
|
|
||
| ```sh | ||
| # Install dependencies | ||
| $ yarn | ||
| ``` | ||
| 2. Run your dev server: | ||
|
|
||
| ```sh | ||
| # Start the site | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| Your project file structure should look something like this | ||
|
|
||
| ``` | ||
| my-docusaurus/ | ||
| docs/ | ||
| doc-1.md | ||
| doc-2.md | ||
| doc-3.md | ||
| website/ | ||
| blog/ | ||
| 2016-3-11-oldest-post.md | ||
| 2017-10-24-newest-post.md | ||
| core/ | ||
| node_modules/ | ||
| pages/ | ||
| static/ | ||
| css/ | ||
| img/ | ||
| package.json | ||
| sidebar.json | ||
| siteConfig.js | ||
| ``` | ||
|
|
||
| # Editing Content | ||
|
|
||
| ## Editing an existing docs page | ||
|
|
||
| Edit docs by navigating to `docs/` and editing the corresponding document: | ||
|
|
||
| `docs/doc-to-be-edited.md` | ||
|
|
||
| ```markdown | ||
| --- | ||
| id: page-needs-edit | ||
| title: This Doc Needs To Be Edited | ||
| --- | ||
|
|
||
| Edit me... | ||
| ``` | ||
|
|
||
| For more information about docs, click [here](https://docusaurus.io/docs/en/navigation) | ||
|
|
||
| ## Editing an existing blog post | ||
|
|
||
| Edit blog posts by navigating to `website/blog` and editing the corresponding post: | ||
|
|
||
| `website/blog/post-to-be-edited.md` | ||
| ```markdown | ||
| --- | ||
| id: post-needs-edit | ||
| title: This Blog Post Needs To Be Edited | ||
| --- | ||
|
|
||
| Edit me... | ||
| ``` | ||
|
|
||
| For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) | ||
|
|
||
| # Adding Content | ||
|
|
||
| ## Adding a new docs page to an existing sidebar | ||
|
|
||
| 1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`: | ||
|
|
||
| ```md | ||
| --- | ||
| id: newly-created-doc | ||
| title: This Doc Needs To Be Edited | ||
| --- | ||
|
|
||
| My new content here.. | ||
| ``` | ||
|
|
||
| 1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`: | ||
|
|
||
| ```javascript | ||
| // Add newly-created-doc to the Getting Started category of docs | ||
| { | ||
| "docs": { | ||
| "Getting Started": [ | ||
| "quick-start", | ||
| "newly-created-doc" // new doc here | ||
| ], | ||
| ... | ||
| }, | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation) | ||
|
|
||
| ## Adding a new blog post | ||
|
|
||
| 1. Make sure there is a header link to your blog in `website/siteConfig.js`: | ||
|
|
||
| `website/siteConfig.js` | ||
| ```javascript | ||
| headerLinks: [ | ||
| ... | ||
| { blog: true, label: 'Blog' }, | ||
| ... | ||
| ] | ||
| ``` | ||
|
|
||
| 2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`: | ||
|
|
||
| `website/blog/2018-05-21-New-Blog-Post.md` | ||
|
|
||
| ```markdown | ||
| --- | ||
| author: Frank Li | ||
| authorURL: https://twitter.com/foobarbaz | ||
| authorFBID: 503283835 | ||
| title: New Blog Post | ||
| --- | ||
|
|
||
| Lorem Ipsum... | ||
| ``` | ||
|
|
||
| For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) | ||
|
|
||
| ## Adding items to your site's top navigation bar | ||
|
|
||
| 1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`: | ||
|
|
||
| `website/siteConfig.js` | ||
| ```javascript | ||
| { | ||
| headerLinks: [ | ||
| ... | ||
| /* you can add docs */ | ||
| { doc: 'my-examples', label: 'Examples' }, | ||
| /* you can add custom pages */ | ||
| { page: 'help', label: 'Help' }, | ||
| /* you can add external links */ | ||
| { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, | ||
| ... | ||
| ], | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation) | ||
|
|
||
| ## Adding custom pages | ||
|
|
||
| 1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`: | ||
| 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: | ||
|
|
||
| `website/siteConfig.js` | ||
| ```javascript | ||
| { | ||
| headerLinks: [ | ||
| ... | ||
| { page: 'my-new-custom-page', label: 'My New Custom Page' }, | ||
| ... | ||
| ], | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages). | ||
|
|
||
| # Full Documentation | ||
|
|
||
| Full documentation can be found on the [website](https://docusaurus.io/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /** | ||
| * Copyright (c) 2017-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| const React = require("react"); | ||
|
|
||
| class Footer extends React.Component { | ||
| docUrl(doc, language) { | ||
| const baseUrl = this.props.config.baseUrl; | ||
| return `${baseUrl}docs/${language ? `${language}/` : ""}${doc}`; | ||
| } | ||
|
|
||
| pageUrl(doc, language) { | ||
| const baseUrl = this.props.config.baseUrl; | ||
| return baseUrl + (language ? `${language}/` : "") + doc; | ||
| } | ||
|
|
||
| render() { | ||
| return ( | ||
| <footer className="nav-footer" id="footer"> | ||
| <section className="sitemap"> | ||
| <a href={this.props.config.baseUrl} className="nav-home"> | ||
| {this.props.config.footerIcon && ( | ||
| <img | ||
| src={this.props.config.baseUrl + this.props.config.footerIcon} | ||
| alt={this.props.config.title} | ||
| width="66" | ||
| height="58" | ||
| /> | ||
| )} | ||
| </a> | ||
| <div> | ||
| <h5>Docs</h5> | ||
| <a href={this.docUrl("getting-started", this.props.language)}> | ||
| Getting Started | ||
| </a> | ||
| <a href={this.docUrl("api", this.props.language)}> | ||
| Api | ||
| </a> | ||
| <a href={this.docUrl("troubleshooting", this.props.language)}> | ||
| Troubleshooting | ||
| </a> | ||
| </div> | ||
| <div> | ||
| <h5>Community</h5> | ||
| <a | ||
| href="http://stackoverflow.com/questions/tagged/react-redux" | ||
| target="_blank" | ||
| rel="noreferrer noopener" | ||
| > | ||
| Stack Overflow | ||
| </a> | ||
| </div> | ||
| <div> | ||
| <h5>More</h5> | ||
| <a href={`${this.props.config.baseUrl}blog`}>Blog</a> | ||
| <a href="https://github.com/reduxjs/react-redux/">GitHub</a> | ||
| <a | ||
| className="github-button" | ||
| href={this.props.config.repoUrl} | ||
| data-icon="octicon-star" | ||
| data-count-href="/reduxjs/react-redux/stargazers" | ||
| data-show-count="true" | ||
| data-count-aria-label="# stargazers on GitHub" | ||
| aria-label="Star this project on GitHub" | ||
| > | ||
| Star | ||
| </a> | ||
| </div> | ||
| </section> | ||
| </footer> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| module.exports = Footer; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "scripts": { | ||
| "start": "docusaurus-start", | ||
| "build": "docusaurus-build", | ||
| "publish-gh-pages": "docusaurus-publish", | ||
| "write-translations": "docusaurus-write-translations", | ||
| "version": "docusaurus-version", | ||
| "rename-version": "docusaurus-rename-version" | ||
| }, | ||
| "devDependencies": { | ||
| "docusaurus": "^1.4.0" | ||
| } | ||
| } |
Oops, something went wrong.