You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Mar 31, 2020. It is now read-only.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A documentation website for the components in this package 📖 Check it out here!
Might seem a little overly-meta to build a documentation site for components for documentation sites, but we need a place to explain usage of these components. 🤷♀️
BUT ALSO:
I'm thinking through the idea of this repository itself being a place we can point people to clone & reuse for their own documentation sites. I've outlined what would need to be done in the README to get a docs site running from cloning this one. It's not perfect but maybe with some reusable variables in package.json or a ✨ cli tool ✨ we can make it a bit easier?
Notes
I copy pasta'd a lot of the repository/publishing/deploying/next config from primer/css, and there is probably some stuff in here that isn't necessary. @shawnbot I could use your help sifting through the files added and making sure we need all of it, since I want this to be a good repo to clone to make new sites.
I'd love your input @shawnbot on whether or not any of the things in /lib/ or /script/ would make sense to export in the package as well. And if so, I'd need help writing documentation for those as I haven't touched them or worked with them yet!
I'll have some more time to look at this tomorrow, but in the meantime, a couple of things:
I don't think we need any of the Metalsmith syncing code for this — sync.js and all of its dependencies — unless we plan on building more sites that need to transform Markdown from a folder outside of pages into MDX.
It would be great if we could publish our Next.js configuration as a "plugin" — i.e. a function that takes options and returns a function that modifies Next's configuration. Then we (and other folks) could get all of the MDX and other goodness without necessarily having to bring along all of the React components.
We should double-check that the weird mangling issues with MDX are still an issue; if not, let's kill that bit of magic in our config.
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
None yet
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR sets up a base for a new docs-components library & documentation site! 🙌
Package:
Documentation Site:
Might seem a little overly-meta to build a documentation site for components for documentation sites, but we need a place to explain usage of these components. 🤷♀️
BUT ALSO:
I'm thinking through the idea of this repository itself being a place we can point people to clone & reuse for their own documentation sites. I've outlined what would need to be done in the README to get a docs site running from cloning this one. It's not perfect but maybe with some reusable variables in package.json or a ✨ cli tool ✨ we can make it a bit easier?
Notes
I copy pasta'd a lot of the repository/publishing/deploying/next config from primer/css, and there is probably some stuff in here that isn't necessary. @shawnbot I could use your help sifting through the files added and making sure we need all of it, since I want this to be a good repo to clone to make new sites.
I'd love your input @shawnbot on whether or not any of the things in
/lib/
or/script/
would make sense to export in the package as well. And if so, I'd need help writing documentation for those as I haven't touched them or worked with them yet!