Skip to content

Commit

Permalink
Merge pull request #859 from Concordium/esbonio-install
Browse files Browse the repository at this point in the history
Preview pull requests solution
  • Loading branch information
dg-concordium authored Aug 11, 2023
2 parents ae8f896 + 7f6d422 commit 5360593
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@
"plaintext",
"restructuredtext"
],
"esbonio.sphinx.confDir": "${workspaceFolder}/source/mainnet"
}
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,12 @@ Images must have :alt: text for accessibility. Generally, image width is 100%. F

GIFs can be inserted but should only be used when it gives clarity to more complex actions. When using GIFs, the :alt: text is StreamPlayer and :align: is center.

## Preview

For non-technical users that might not want to install the tools above, you can request a preview in the GitHub pull request. The preview is added as a comment in the pull request and opens as a web page.

Another alternative if you do not want to build the documentation to preview, is to install install Esbonio https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio into VSCode. Then you can use the command palette to run >Esbonio:OpenPreview. This builds a preview file. This solution still requires that you have VSCode installed and the repository locally on your computer.

## License

This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
Expand Down

0 comments on commit 5360593

Please sign in to comment.