-
Notifications
You must be signed in to change notification settings - Fork 2
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
Adds tabbed content, annotations, and admonitions #30
base: main
Are you sure you want to change the base?
Conversation
@Burhan-Q Can you please make an edit to the code in the pr (say update a doc page or something). We just implemented functionality that should build the entire site based on this PR. Doing so will make it easier for us to review changes. |
@thesteve0 added some white space, hopefully that helps |
Sorry on mobile at the moment, but seems like there's a permission problem
|
@tom-vx51 Looks like people outside 51 may get the permissions issue |
Might need the
|
Is the preview action working properly for repo maintainers? I tried using it on my fork (again, trying it all from mobile) and this was the result https://burhan-q.github.io/voxel51-docs/pr-preview/pr-2/ where the |
It's a known issue you can't deploy from forks :( - we are investigating a solution that will allow for community builds |
Overview
Proposal to some updates for new docs pages. Specifically for
docs\getting_started\basic\install.md
docs\getting_started\basic\virtualenv.md
docs\fiftyone_concepts\running_environments.md
Apologies for the big PR. I intended originally to specifically add the tabbed content, but found several other areas that felt (to me) could use some attention.
Summary of Changes
markdown_extensions
alphabeticallyfrontmatter
for keywords to help surface relevant contentuv
shell
where appropriatejson
where appropriatemkdocs.yml
peryaml-lint
errors (ignored other errors as it was not obvious that they needed to be fixed)$
and>>>
from code blocks for consistencyPreview
Admonitions and Tabbed content (expand for screenshot)
Admonitions and Annotations (expand for screenshot)