Skip to content
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

Jump to bottom

[v2] blog rss feed #1698

Closed
endiliey opened this issue Jul 24, 2019 · 5 comments · Fixed by #1916
Closed

[v2] blog rss feed #1698

endiliey opened this issue Jul 24, 2019 · 5 comments · Fixed by #1916
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.

Comments

@endiliey
Copy link
Contributor

endiliey commented Jul 24, 2019 •
edited
Loading

Tip: This task is targeted towards potential contributor to Docusaurus project.

🚀 Motivation

We need to generate blog rss feed in v2

Where to start

  1. Fork the repository and create your branch from master.
  2. Clone the repository
  3. yarn install in the root of the repo
  4. The related codes for the blog plugin is https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-content-blog
  5. To run docusaurus 2 website, run yarn start at root
  6. To build docusaurus 2 website, run yarn build at root
  7. Propose a fix and send a Pull Request :)

P.S: make sure to comment on this issue first and propose a solution before working on a fix

Have you read the Contributing Guidelines on issues?

Yes
@endiliey endiliey added help wanted Asking for outside help and/or contributions to this particular issue or PR. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. 2.x labels Jul 24, 2019
@gimdongwoo gimdongwoo mentioned this issue Sep 15, 2019
Merged
@faelribeiro22
Copy link

@endiliey This issue is still open?

@endiliey
Copy link
Contributor Author

@faelribeiro22 yep it is. wanna work on it ? 😉

@moozzyk
Copy link
Contributor

moozzyk commented Oct 25, 2019

Is the idea here to pretty much follow the logic used in the plugin-content-blog but instead of pushing posts to paginated results create an RSS feed (potentially using rss or feed package)?

@endiliey
Copy link
Contributor Author

yep. @moozzyk

@moozzyk
Copy link
Contributor

moozzyk commented Oct 25, 2019 via email

@moozzyk moozzyk mentioned this issue Oct 30, 2019
Merged
endiliey pushed a commit that referenced this issue Nov 6, 2019
@moozzyk @endiliey
feat(v2): Implement plugin creating feed for blog posts (#1916)
ff83e6f 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(v2): Implement plugin creating feed for blog posts
3 participants
@moozzyk @faelribeiro22 @endiliey