Skip to content

Conversation

@kevindantas
Copy link
Owner

Summary

  • Add support to Markdown as documentation
  • Add component API to the website along side the demos
  • Fixed a bug when preview the date on the Calendar component

Screenhots

kevindantas github io_react-date-range_

kevindantas github io_react-date-range_ (1)

@kevindantas
Copy link
Owner Author

I'm not sure what's the best strategy to create documentation for a lib, I saw that MaterialUI and Ant Design uses markdown to create their website documentation.
Do you guys have any suggestion about that?

@mikelfcosta
Copy link
Collaborator

I'm not sure what's the best strategy to create documentation for a lib, I saw that MaterialUI and Ant Design uses markdown to create their website documentation.
Do you guys have any suggestion about that?

I've used markdown before to create documentations. I think it's one of the best ways to do it, or using the gitbook.io service. I've actually recreated something like gitbook.io before.

@kevindantas
Copy link
Owner Author

I was thinking in using Storybook, but I'm not sure how it scales with an entire UI library, I always see being used for more specific cases, like the react-dates from Airbnb.

@mikelfcosta
Copy link
Collaborator

We could use Storybook for the whole UI Library.

@pedrodurek
Copy link
Collaborator

It's got awesome!

@pedrodurek
Copy link
Collaborator

gitbook is paid, for now we could use just regular markdown

@kevindantas kevindantas changed the base branch from master to feature/improve-mobile-ux March 29, 2019 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants