Easy to maintain open source documentation websites. https://docusaurus.io/
Go to file
Pawel Kadluczka ff83e6f8bc 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"><![CDATA[![First Birthday Slash](/img/docusaurus-slash-first-birthday.svg)]]></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"><![CDATA[Docusaurus was [officially announced](https://docusaurus.io/blog/2017/12/14/introducing-docusaurus) 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"><![CDATA[![Introducing Slash](/img/slash-introducing.svg)]]></summary>
    </entry>
</feed>
```

* new feedOptions type 'all' and use correct path
2019-11-06 14:45:31 +07:00
.circleci chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
.github misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
admin misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
docs docs(v2): add windows batch instructions for publishing to gh pages (#1914) 2019-10-29 23:49:01 +07:00
packages feat(v2): Implement plugin creating feed for blog posts (#1916) 2019-11-06 14:45:31 +07:00
scripts misc: use /usr/bin/env bash to increase portability (#1923) 2019-11-03 22:29:16 +08:00
website feat(v2): Implement plugin creating feed for blog posts (#1916) 2019-11-06 14:45:31 +07:00
website-1.x v2.0.0-alpha.32 2019-11-04 12:45:05 +07:00
.editorconfig Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.eslintignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.eslintrc.js chore(v2): tweak eslint config (#1445) 2019-05-09 20:01:48 +07:00
.gitattributes Add .webp to .gitattributes for ignoring 2018-05-03 13:13:03 -07:00
.gitignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.prettierignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.prettierrc refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) 2019-05-20 09:59:04 -07:00
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) 2017-12-18 14:40:52 -08:00
CHANGELOG-2.x.md feat(v2): Implement plugin creating feed for blog posts (#1916) 2019-11-06 14:45:31 +07:00
CHANGELOG.md docs(v1): fix links in CHANGELOG (#1931) 2019-11-02 08:12:52 +08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-07-31 19:49:46 -07:00
CONTRIBUTING.md misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
LICENSE The complete move to MIT license (#115) 2017-10-05 11:14:49 -07:00
LICENSE-docs Docusaurus documentation license (#118) 2017-10-06 12:59:01 -07:00
README.md misc: update URLs to non-HTML versions (#1902) 2019-10-27 20:06:11 -07:00
babel.config.js refactor(v2): migrate to Typescript ❄️🌀🐋 (#1490) 2019-05-18 11:37:35 -07:00
crowdin.yaml chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
jest.config.js fix(v2): docs plugin stability improvement (100% test coverage) (#1912) 2019-10-29 23:59:27 +08:00
lerna.json v2.0.0-alpha.32 2019-11-04 12:45:05 +07:00
package.json chore(v2): upgrade dependencies (#1865) 2019-10-21 12:25:30 +07:00
tsconfig.json refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) 2019-05-20 09:59:04 -07:00
yarn.lock feat(v2): Implement plugin creating feed for blog posts (#1916) 2019-11-06 14:45:31 +07:00

Docusaurus

Docusaurus

npm version CircleCI status PRs Welcome Chat code style: prettier Tested with Jest Netlify Status

Introduction

Docusaurus is a project for easily building, deploying, and maintaining open source project websites.

  • Simple to Start Docusaurus is built to be easy to get up and running in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.
  • Localizable Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.
  • Customizable While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.

Installation

Docusaurus is available as the docusaurus package on npm.

We have also released the docusaurus-init package to make getting started with Docusaurus even easier.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner Friendly Bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner friendly bugs that contain bugs which are fairly easy to fix. This is a great place to get started.

Contact

We have a few channels for contact:

  • Discord with two text channels:
    • #docusaurus-users for those using Docusaurus.
    • #docusaurus-dev for those wanting to contribute to the Docusaurus core.
  • @docusaurus on Twitter
  • GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.