Skip to content

Commit

Permalink
Rename copy-sdk-docs yarn command
Browse files Browse the repository at this point in the history
  • Loading branch information
NateWilliams2 committed Mar 26, 2024
1 parent 6256b8a commit 50f8c7d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Then you can return to the developer-documentation directory and run the yarn sc
~~~bash
# Set the vocdoni sdk folder path
export VOCDONI_SDK_PATH=......
yarn fix-sdk-docs
yarn copy-sdk-docs
~~~

Note that the SDK docs are tracked by git, and you should not need to do this if you are not a repo maintainer.
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
"gen-post": "if [ \"$(uname)\" = \"Darwin\" ]; then npm run gen-post:Darwin; else npm run gen-post:Linux; fi",
"gen-post:Darwin": "grep -L \"mdx-code-block\" docs/vocdoni-api/** | xargs -I {} sed -i '' -e $'/^\\(<\\)/i\\\n````mdx-code-block\n' -e $'/^\\(<\\)/a\\\n````' {}",
"gen-post:Linux": "grep -L \"mdx-code-block\" docs/vocdoni-api/** | xargs sed -i -e '/^\\(<\\)/i````mdx-code-block' -e '/^\\(<\\)/a````'",
"fix-sdk-docs": "if [ \"$(uname)\" = \"Darwin\" ]; then npm run fix-sdk-docs:Darwin; else npm run fix-sdk-docs:Linux; fi",
"fix-sdk-docs:Darwin": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && brew install gsed && find ./docs/sdk/reference -type f | xargs gsed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'",
"fix-sdk-docs:Linux": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && find ./docs/sdk/reference -type f | xargs sed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'"
"copy-sdk-docs": "if [ \"$(uname)\" = \"Darwin\" ]; then npm run fix-sdk-docs:Darwin; else npm run fix-sdk-docs:Linux; fi",
"copy-sdk-docs:Darwin": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && brew install gsed && find ./docs/sdk/reference -type f | xargs gsed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'",
"copy-sdk-docs:Linux": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && find ./docs/sdk/reference -type f | xargs sed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'"
},
"dependencies": {
"@aragon/ui-components": "0.1.3",
Expand Down

0 comments on commit 50f8c7d

Please sign in to comment.