From c9de2bf2b1e85c835eb3bbeec6dba5f6ed24abec Mon Sep 17 00:00:00 2001 From: dg-concordium Date: Thu, 10 Aug 2023 10:41:18 +0200 Subject: [PATCH 1/3] Preview pull requests solution --- .vscode/settings.json | 1 + README.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index 74976998ca..63ff33f90b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,4 +13,5 @@ "plaintext", "restructuredtext" ], + "esbonio.sphinx.confDir": "${workspaceFolder}/source/mainnet" } diff --git a/README.md b/README.md index 90d86879b3..4ed071c200 100644 --- a/README.md +++ b/README.md @@ -296,6 +296,10 @@ 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 + +If you do not want to build the documentation to preview, you can install Esbonio https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio into VSCode. Then you can use the search bar 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]. From 23a4d2e14a2b69fdfd1eaa93e54be1b908c43b7a Mon Sep 17 00:00:00 2001 From: dg-concordium <95341910+dg-concordium@users.noreply.github.com> Date: Thu, 10 Aug 2023 13:46:53 +0200 Subject: [PATCH 2/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Emil Holm Gjørup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ed071c200..b27f781f8f 100644 --- a/README.md +++ b/README.md @@ -298,7 +298,7 @@ GIFs can be inserted but should only be used when it gives clarity to more compl ## Preview -If you do not want to build the documentation to preview, you can install Esbonio https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio into VSCode. Then you can use the search bar 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. +If you do not want to build the documentation to preview from the terminal, you can 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 From bbfd8c2d9eca3aba23848edf22cda1199598c880 Mon Sep 17 00:00:00 2001 From: dg-concordium Date: Fri, 11 Aug 2023 08:03:04 +0200 Subject: [PATCH 3/3] Add preview solution --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ed071c200..404cba9b5a 100644 --- a/README.md +++ b/README.md @@ -298,7 +298,9 @@ GIFs can be inserted but should only be used when it gives clarity to more compl ## Preview -If you do not want to build the documentation to preview, you can install Esbonio https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio into VSCode. Then you can use the search bar 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. +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 search bar 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