-
Notifications
You must be signed in to change notification settings - Fork 17
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
Website integration #365
Website integration #365
Conversation
Give better header name to component API doc intro pages
Inherit CSS
Upgrade mkdocs
Import some existing pages
Include `site_url`, `repo_url`, and `source_locations` in each component to display repo and source code location links
Update Dotenv to use `.load`
Build wise I think I can get away with having merges to master trigger a build to the In this way, the dev version will always represent the latest commit for each component. But the live version will only represent the latest release for each component. I think this is reasonable, as called out in #137 (comment), only the latest version of the component is supported at the moment. So I don't think we need to get complicated in being able to view the docs for a specific version of a component. This approach also does require the whole doc site to be re-built on every change, even if a component was unchanged, or if only one of them was released. Don't think this is a big deal tho. Build is pretty quick and cloudflare can handle the bandwidth 😅. |
Integrates the contextual documentation into the monorepo, using the monorepo as the root mkdocs project. Each component is setup as its own project via https://squidfunk.github.io/mkdocs-material/plugins/projects/. This should make it easier to maintain as everything is now in one place.
This PR also brings some changes to the website itself to make it easier to use, navigate, and find information. The one of the added benefits is viewing the API docs for a specific component will now properly show the version/link to GH in top right corner vs always being for the framework component.
TODO:
projects
plugin sub-project watcher for "external" files squidfunk/mkdocs-material#6945 (comment)Resolves #137