search

react-spectre / react-spectre

React components for Spectre.css - a Lightweight, Responsive and Modern CSS Framework
MIT License
65 stars 13 forks source link

Implement docusaurus website #34

Open 0aps opened 6 years ago

0aps commented 6 years ago

We need to create a docusaurus based website to display the documentation for the end user.

Regards, Ángel

0aps commented 6 years ago

Guys, I'll integrate a basic setup for a docusaurus based website with couple of examples. I don't have much experience with it so will do the bootstrapping and we'll improve it gradually.

@rmariuzzo what do you think? do you have any preferable way to set it up or do you prefer to do this yourself, at least initially?

Regards Ángel

rmariuzzo commented 6 years ago

Hey @0aps! If you want to take initiative go ahead. When I thought about using Docusaurus it was to create public face of this project which will look similarly to how Spectre.css is structured. However, as you mentioned, we want to bring a way to show how to use the code. I would like to explore into live editing too. :)

rmariuzzo commented 6 years ago

I'm checking this right now.

rmariuzzo commented 6 years ago

Got this so far, very basic: https://react-spectre.github.io/, repo is located here: https://github.com/react-spectre/react-spectre.github.io

0aps commented 6 years ago

great! Good thing I didn't start because I wasn't thinking on a different repo. hehe But it totally makes more sense that way.

Only question I have is about duplicating documentation (readme of each package) and the documentation for the end-user. Does it makes sense to implement something which extract/uses the readme of each packages to be displayed in the public page too? In thay way, we don't have to keep up to date both repos docs.

On a side note, maybe it makes sense to move this issue to the other repo.

Regards, Ángel

rmariuzzo commented 6 years ago

Indeed, this is a good point. We don't want have to duplicate efforts. Probably, we will move all docs to the public site instead.

rmariuzzo commented 6 years ago

I made some progress, but feels like docusaurus will not fit what I want which is be able to easily render our React Components :-(

0aps commented 6 years ago

what do you mean by easily render our React Components? what part we're not able to do with Docusaurus?

rmariuzzo commented 6 years ago

The docs format are rendered in markdown... which I still don't know how to render a React component inside the markdown.

rmariuzzo commented 6 years ago

@0aps I'm looking at Gatsby right now and so far it looks promising.