Commit Graph

8 Commits

Author SHA1 Message Date
John Knox
5f1a0548f5 Migrate website to Docusaurus 2
Summary:
Docusaurus 2 is quite a lot more powerful than docu 1 it turns out.
This should convert the website fully.

* [done] Go through migration guide https://v2.docusaurus.io/docs/migrating-from-v1-to-v2
* [done] Convert landing page html
* [done] Convert all images to img tags
* [done] Convert all .md files to .mdx
* [done] Make sure ui-doc generation and including still works
* [done] Scan every page visually for sanity check
* [done] Make sure footer still works
* [done] Make sure search still works
* [done] Change all links/ to links/index
* [done] Change all links.md to links
* [done] Add some custom css to make the navbar look like the old one and darken the footer.

Reviewed By: passy

Differential Revision: D21158717

fbshipit-source-id: 5f45b711b1b6fd5ece4c5c15c55635c7ebbfb568
2020-04-27 04:05:01 -07:00
John Knox
a5dbfbb82d Fix UI-doc generation
Summary: I noticed the UI components page was empty, the components have been moved and the generator was still looking in the old place.

Reviewed By: passy

Differential Revision: D21131943

fbshipit-source-id: 3310d4f7c88ea0f1e77a13c81eb411f9b1475125
2020-04-20 09:41:42 -07:00
Andres Suarez
0675dd924d Tidy up Flipper license headers [1/2]
Reviewed By: passy

Differential Revision: D17863711

fbshipit-source-id: 259dc77826fb803ff1b88c88529d7f679d3b74d8
2019-10-11 13:46:45 -07:00
Daniel Büchele
98b4071242 react-docgen for TypeScript
Summary: Update react-docgen to support TypeScript

Reviewed By: passy

Differential Revision: D17204178

fbshipit-source-id: 408ce5569a253c9a836f65bd9a9f289cc82b5175
2019-09-05 07:43:11 -07:00
John Knox
c866ba9428 Fix website yarn start
Summary: Inlining the component docs header instead of reading it from the same file we write to.

Reviewed By: passy

Differential Revision: D15199683

fbshipit-source-id: dc34e25b5f8073aa582f90a14bc875c8e8c431db
2019-05-03 09:47:59 -07:00
John Knox
733d61132e Restore UI components page in sidebar
Summary: This was missing because it was still being generated in /docs.

Reviewed By: danielbuechele

Differential Revision: D15198144

fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
2019-05-03 07:10:57 -07:00
Daniel Büchele
95a7298d21 updating UI documentation
Summary:
adding documentation for more of our UI components.

Deleted some unused components, which were not working anyways.

Reviewed By: jknoxville

Differential Revision: D12896109

fbshipit-source-id: 959c7864240883869ad67283f80a3c189b94bf00
2018-11-05 03:12:23 -08:00
Daniel Büchele
640dee6645 auto generated UI docs
Summary:
Using `react-docgen` to automatically generate docs for our UI components.
React-docgen parses the files in `components/ui` and using comments and flowtypes to generate structured information about the UI components.

For higher-order-components `react-docgen` is not able to get the information. As we are using HOC often as part of emotion's styled-components, I added a custom parser for HOCs. Using babel/parser I am parsing the components and using their doc-comments to generate the structured description.

Then, the description generated by react-docgen and my custom parser is used to generate markdown which is added to the `ui-components.md` file of our docs.

Plus: Added some styling around the documentation of props, mostly table styles.

Reviewed By: jknoxville

Differential Revision: D12896110

fbshipit-source-id: 1337c924c06e10a5d3aa752579428fd2cc7b4743
2018-11-05 03:12:23 -08:00