-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Added Documentation for React-bootstrap #1486
Added Documentation for React-bootstrap #1486
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you. Please see my review comments.
@@ -0,0 +1,17 @@ | |||
module Docs | |||
class ReactBootstrap | |||
class CleanHtmlFilter < Filter |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please clean as much from the original HTML as possible:
- Unwrap
._page _simple
(in particular to make some CSS selectors of DevDocs effective). - A non exhaustive list of classes that should be removed:
___gatsby
,gatsby-focus-wrapper
,flex-xl-nowrap row
,Heading-styles-module--heading--3cEKx __heading
,ReactPlayground-StyledContainer-module--cls2--3Uz4N ReactPlayground-StyledContainer-module--cls1--1Jg9m
-- As a rule of thumb, we try to remove every class which is not strictly necessary to minimize the docs size.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @simon04 , thanks for the review, I have fixed the second bullet point, which is to remove most of the unnecessary classes. But I would like to keep the styling as "simple" please. As the default "simple" stylesheet looks pretty good in my opinion.
Co-authored-by: Simon Legner <Simon.Legner@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
If you’re adding a new scraper, please ensure that you have:
public/icons/your_scraper_name/
directory:16.png
: a 16×16 pixel icon for the doc16@2x.png
: a 32×32 pixel icon for the docSOURCE
: A text file containing the URL to the page the image can be found on or the URL of the original image itself