2018-10-25 20:03:19 -04:00
|
|
|
/**
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
|
2018-09-17 00:50:43 -04:00
|
|
|
module.exports = {
|
2018-11-11 11:25:13 -05:00
|
|
|
title: 'Docusaurus',
|
2019-07-17 09:53:40 -04:00
|
|
|
tagline: 'Easy to Maintain Open Source Documentation Websites',
|
2018-09-21 06:46:19 -04:00
|
|
|
organizationName: 'facebook',
|
|
|
|
|
projectName: 'docusaurus',
|
2018-09-17 03:34:55 -04:00
|
|
|
baseUrl: '/',
|
2019-05-26 19:43:28 -04:00
|
|
|
url: 'https://v2.docusaurus.io',
|
2018-10-28 04:32:19 -04:00
|
|
|
favicon: 'img/docusaurus.ico',
|
2019-06-10 02:21:36 -04:00
|
|
|
themes: ['@docusaurus/theme-live-codeblock'],
|
2019-07-17 09:53:40 -04:00
|
|
|
plugins: [
|
|
|
|
|
[
|
|
|
|
|
'@docusaurus/plugin-ideal-image',
|
|
|
|
|
{
|
|
|
|
|
quality: 70,
|
|
|
|
|
max: 1030, // max resized image's size.
|
|
|
|
|
min: 640, // min resized image's size. if original is lower, use that size.
|
|
|
|
|
steps: 2, // the max number of images generated between min and max (inclusive)
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
],
|
2019-06-10 02:21:36 -04:00
|
|
|
presets: [
|
|
|
|
|
[
|
|
|
|
|
'@docusaurus/preset-classic',
|
|
|
|
|
{
|
|
|
|
|
docs: {
|
|
|
|
|
path: 'docs',
|
|
|
|
|
sidebarPath: require.resolve('./sidebars.js'),
|
2019-10-10 14:10:18 -04:00
|
|
|
editUrl:
|
|
|
|
|
'https://github.com/facebook/docusaurus/edit/master/website/docs/',
|
2019-10-11 00:45:39 -04:00
|
|
|
showLastUpdateAuthor: true,
|
|
|
|
|
showLastUpdateTime: true,
|
2019-06-10 02:21:36 -04:00
|
|
|
},
|
|
|
|
|
blog: {
|
|
|
|
|
path: '../website-1.x/blog',
|
|
|
|
|
postsPerPage: 3,
|
feat(v2): Implement plugin creating feed for blog posts (#1916)
* feat(v2): Implement feed for blog posts
Fixes: #1698
Test plan:
- added tests
Ran `yarn build` on website with the following config (and disabled blog
from preset-classic):
```js
[
'@docusaurus/plugin-content-blog',
{
path: '../website-1.x/blog',
feedOptions: {
copyright: 'Copy',
type: 'atom',
},
},
],
```
which genereted the following feed:
```xml
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<id>https://v2.docusaurus.io/blog</id>
<title>Docusaurus Blog</title>
<updated>2018-12-14T00:00:00.000Z</updated>
<generator>https://github.com/jpmonette/feed</generator>
<link rel="alternate" href="https://v2.docusaurus.io/blog"/>
<subtitle>Docusaurus Blog</subtitle>
<icon>https://v2.docusaurus.io/img/docusaurus.ico</icon>
<rights>Copy</rights>
<entry>
<title type="html"><![CDATA[Happy 1st Birthday Slash!]]></title>
<id>Happy 1st Birthday Slash!</id>
<link href="https://v2.docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash"/>
<updated>2018-12-14T00:00:00.000Z</updated>
<summary type="html"><]]></summary>
</entry>
<entry>
<title type="html"><![CDATA[Towards Docusaurus 2]]></title>
<id>Towards Docusaurus 2</id>
<link href="https://v2.docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2"/>
<updated>2018-09-11T00:00:00.000Z</updated>
<summary type="html">< over nine months ago as a way to easily build open source documentation websites. Since then, it has amassed over 8,600 GitHub Stars, and is used by many popular open source projects such as [React Native](https://facebook.github.io/react-native/), [Babel](https://babeljs.io/), [Jest](https://jestjs.io/), [Reason](https://reasonml.github.io/) and [Prettier](https://prettier.io/).]]></summary>
</entry>
<entry>
<title type="html"><![CDATA[How I Converted Profilo to Docusaurus in Under 2 Hours]]></title>
<id>How I Converted Profilo to Docusaurus in Under 2 Hours</id>
<link href="https://v2.docusaurus.io/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus"/>
<updated>2018-04-30T00:00:00.000Z</updated>
<summary type="html"><![CDATA[> _“Joel and I were discussing having a website and how it would have been great to launch with it. So I challenged myself to add Docusaurus support. It took just over an hour and a half. I'm going to send you a PR with the addition so you can take a look and see if you like it. Your workflow for adding docs wouldn't be much different from editing those markdown files.”_]]></summary>
</entry>
<entry>
<title type="html"><![CDATA[Introducing Docusaurus]]></title>
<id>Introducing Docusaurus</id>
<link href="https://v2.docusaurus.io/blog/2017/12/14/introducing-docusaurus"/>
<updated>2017-12-14T00:00:00.000Z</updated>
<summary type="html"><]]></summary>
</entry>
</feed>
```
* new feedOptions type 'all' and use correct path
2019-11-06 02:45:31 -05:00
|
|
|
feedOptions: {
|
|
|
|
|
type: 'all',
|
|
|
|
|
copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`,
|
|
|
|
|
},
|
2019-06-10 02:21:36 -04:00
|
|
|
},
|
|
|
|
|
theme: {
|
2019-06-15 12:59:23 -04:00
|
|
|
customCss: require.resolve('./src/css/custom.css'),
|
2019-06-10 02:21:36 -04:00
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
],
|
2019-05-08 04:21:11 -04:00
|
|
|
themeConfig: {
|
2019-07-12 12:23:49 -04:00
|
|
|
image: 'img/docusaurus.png',
|
2019-06-10 02:21:36 -04:00
|
|
|
gtag: {
|
|
|
|
|
trackingID: 'UA-141789564-1',
|
|
|
|
|
},
|
2019-06-10 03:16:06 -04:00
|
|
|
// googleAnalytics: {
|
|
|
|
|
// trackingID: 'UA-141789564-1',
|
|
|
|
|
// },
|
2019-05-08 04:21:11 -04:00
|
|
|
algolia: {
|
|
|
|
|
apiKey: '47ecd3b21be71c5822571b9f59e52544',
|
|
|
|
|
indexName: 'docusaurus-2',
|
|
|
|
|
algoliaOptions: {},
|
|
|
|
|
},
|
2019-05-17 03:54:11 -04:00
|
|
|
navbar: {
|
|
|
|
|
title: 'Docusaurus',
|
|
|
|
|
logo: {
|
|
|
|
|
alt: 'Docusaurus Logo',
|
|
|
|
|
src: 'img/docusaurus.svg',
|
|
|
|
|
},
|
|
|
|
|
links: [
|
|
|
|
|
{to: 'docs/introduction', label: 'Docs', position: 'left'},
|
|
|
|
|
{to: 'blog', label: 'Blog', position: 'left'},
|
2019-07-14 00:44:40 -04:00
|
|
|
{to: 'showcase', label: 'Showcase', position: 'left'},
|
2019-05-17 03:54:11 -04:00
|
|
|
{to: 'feedback', label: 'Feedback', position: 'left'},
|
|
|
|
|
{
|
|
|
|
|
href: 'https://github.com/facebook/docusaurus',
|
|
|
|
|
label: 'GitHub',
|
|
|
|
|
position: 'right',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2019-05-16 02:27:52 -04:00
|
|
|
footer: {
|
|
|
|
|
style: 'dark',
|
|
|
|
|
links: [
|
|
|
|
|
{
|
|
|
|
|
title: 'Docs',
|
|
|
|
|
items: [
|
|
|
|
|
{
|
|
|
|
|
label: 'Introduction',
|
|
|
|
|
to: 'docs/introduction',
|
|
|
|
|
},
|
|
|
|
|
{
|
2019-07-26 11:42:03 -04:00
|
|
|
label: 'Installation',
|
|
|
|
|
to: 'docs/installation',
|
2019-05-16 02:27:52 -04:00
|
|
|
},
|
2019-10-12 04:03:51 -04:00
|
|
|
{
|
|
|
|
|
label: 'Migration from v1 to v2',
|
2019-10-12 15:02:16 -04:00
|
|
|
to: 'docs/migrating-from-v1-to-v2',
|
2019-10-12 04:03:51 -04:00
|
|
|
},
|
2019-05-16 02:27:52 -04:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
title: 'Community',
|
|
|
|
|
items: [
|
|
|
|
|
{
|
|
|
|
|
label: 'Stack Overflow',
|
|
|
|
|
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
label: 'Feedback',
|
|
|
|
|
to: 'feedback',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
label: 'Discord',
|
|
|
|
|
href: 'https://discordapp.com/invite/docusaurus',
|
|
|
|
|
},
|
2019-10-12 04:03:51 -04:00
|
|
|
{
|
|
|
|
|
label: 'Help',
|
|
|
|
|
to: 'help',
|
|
|
|
|
},
|
2019-05-16 02:27:52 -04:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
title: 'Social',
|
|
|
|
|
items: [
|
|
|
|
|
{
|
|
|
|
|
label: 'Blog',
|
|
|
|
|
to: 'blog',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
label: 'GitHub',
|
|
|
|
|
href: 'https://github.com/facebook/docusaurus',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
label: 'Twitter',
|
|
|
|
|
href: 'https://twitter.com/docusaurus',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
logo: {
|
|
|
|
|
alt: 'Facebook Open Source Logo',
|
|
|
|
|
src: 'https://docusaurus.io/img/oss_logo.png',
|
|
|
|
|
},
|
|
|
|
|
copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`,
|
|
|
|
|
},
|
2018-10-28 04:32:19 -04:00
|
|
|
},
|
2018-09-17 00:50:43 -04:00
|
|
|
};
|