Docusaurus basics #11752
Open
Docusaurus basics #11752
Conversation
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
plaindocs
requested review from
humitos
and removed request for
a team and
ericholscher
stsewd
reviewed
Nov 7, 2024
|
@stsewd yup, sounds good, thanks |
File Tree Diff won't work here either... |
humitos
reviewed
Nov 11, 2024
Comment on lines
+22
to
+33
| commands: | ||
| # "docs/" was created following the Docusaurus tutorial: | ||
| # npx create-docusaurus@latest docs classic | ||
| # but you can just use your existing Docusaurus site | ||
| # | ||
| # Install Docusaurus dependencies | ||
| - cd docs/ && npm install | ||
| # Build the site | ||
| - cd docs/ && npm run build | ||
| # Copy generated files into Read the Docs directory | ||
| - mkdir --parents $READTHEDOCS_OUTPUT/html/ | ||
| - cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/ |
There was a problem hiding this comment.
Once we merge and deploy #11710 this would be as following:
build:
install:
- cd docs/ && npm install
build:
html:
- cd docs/ && npm run build
post_build:
- mkdir --parents $READTHEDOCS_OUTPUT/html/
- cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Not a lot of info here, but probably worth pushing out anyway
📚 Documentation previews 📚
docs): https://docs--11752.org.readthedocs.build/en/11752/dev): https://dev--11752.org.readthedocs.build/en/11752/