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.

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

discussion: Add some example docs for docusaurus #241

Open
wants to merge 1 commit into
base: docusaurus
Choose a base branch
from

Conversation

anajavi
Copy link
Collaborator

@anajavi anajavi commented Oct 11, 2019

This PR is just for discussion purposes in order to have directory structure and conventions for the component docs.

I just quickly added some component docs just to see how the structure feels to use.

I did not see need for separate docs and api, so I just squashed them together.

@codecov-io
Copy link

codecov-io commented Oct 11, 2019

Codecov Report

Merging #241 into docusaurus will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           docusaurus     #241   +/-   ##
===========================================
  Coverage       90.55%   90.55%           
===========================================
  Files              70       70           
  Lines             889      889           
  Branches          168      168           
===========================================
  Hits              805      805           
  Misses             71       71           
  Partials           13       13

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d717aef...4ccfa9f. Read the comment docs.

@anajavi
Copy link
Collaborator Author

anajavi commented Oct 12, 2019

Found something interesting, which is included in the coming docusaurus v2.

React components can be embedded in page using MDX. That would be really helpful when writing component api docs. No need to embed stackblitz examples then.

@anajavi anajavi requested a review from whawker October 12, 2019 06:43
@whawker
Copy link
Owner

whawker commented Oct 14, 2019

Docs structure looks good, although I wonder if we should completely split the 3 variants to avoid confusion and keep things concise?

That MDX stuff looks cool - I saw the docusaurus v2 note, but didn't thing to check it out. It looks pretty close, I'm think we should skip v1 entirely to avoid future work.

@anajavi
Copy link
Collaborator Author

anajavi commented Jun 4, 2020

The work-in-progress react-leaflet docusaurus site includes live editor: https://react-leaflet-v3.now.sh

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.

3 participants