Documentation generation polish
mathieudutour opened this issue · comments
Follow up from #316
- figure out fonts
- figure out personalization (eg. "forking" the pages)
- add different languages for the code examples
- generate social cards for component pages (when sharing on twitter, slack, etc.)
- generate an appcast for the sketch library and add a button to add it as a library directly (instead of downloading the file)
I had an interesting idea for personalization. It'd be interesting if we generated actual md/mdx files for each page, and then people who don't use gatsby or who want completely custom styles/layouts could load those into their existing site however they want. We would also make the components that we use within the mdx files available for import. It'd be nice if there were also an easier way to make smaller customizations, but this seems like a powerful option for major customizations.
We would also make the components that we use within the mdx files available for import
That's def something we need to do yes
One idea I had was to provide:
- an option to specify the path to one or more templates (the components here: https://github.com/airbnb/Lona/tree/master/compiler/generate-docs/templates)
- provide a command to copy paste the lona workspace of the documentation and add an option to specify its path
That way you have 2 different ways to personalize the docs: one with total control over everything, and one just changing the UI.
Then I want to create a gatsby theme which is an experimental feature to share a gatsby configuration. So they could use the theme in an existing gatsby site to add all the /u/... pages for a workspace for example
Those all sound good to me. I think if we had all of those, that'd be enough flexibility for pretty much any use case