diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63fbf3bfd1b8ed..38e1d36aca0470 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,7 +199,7 @@ You can download the `hub` tool from https://hub.github.com/ . Using to make PRs. Most remote operations can be done through the `hub` CLI command. -> **Note** +> [!NOTE] > You still need to have a GitHub account. ### Preparation: diff --git a/README.md b/README.md index 7efab7d783007a..d0e96902e2b637 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ V is constantly being updated. To update V, simply run: v up ``` -> **Note** +> [!NOTE] > If you run into any trouble, or you have a different operating > system or Linux distribution that doesn't install or work immediately, please see > [Installation Issues](https://github.com/vlang/v/discussions/categories/installation-issues) @@ -123,7 +123,7 @@ Otherwise, follow these instructions: ### Symlinking -> **Note** +> [!NOTE] > It is *highly recommended*, that you put V on your PATH. That saves > you the effort to type in the full path to your v executable every time. > V provides a convenience `v symlink` command to do that more easily. @@ -149,7 +149,7 @@ v symlink That will make V available everywhere, by adding it to your PATH. Please restart your shell/editor after that, so that it can pick up the new PATH variable. -> **Note** +> [!NOTE] > There is no need to run `v symlink` more than once - v will still be available, even after > `v up`, restarts, and so on. You only need to run it again if you decide to move the V repo > folder somewhere else. diff --git a/TESTS.md b/TESTS.md index c3803cdde1cc1f..3ad3cf35bbeb34 100644 --- a/TESTS.md +++ b/TESTS.md @@ -60,7 +60,7 @@ matches an expected .out file. You can also check for code that does panic using this test runner - just paste the start of the `panic()` output in the corresponding .out file. -> **Note** +> [!NOTE] > These tests, expect to find a pair of `.vv` and `.out` files, in the folder: > vlib/v/slow_tests/inout @@ -84,7 +84,7 @@ file is compiled with `-o -` . This *test runner*, checks whether whole project folders, can be compiled, and run. -> **Note** +> [!NOTE] > Each project in these folders, should finish with an exit code of 0, > and it should output `OK` as its last stdout line. @@ -160,7 +160,7 @@ This runs tests for: * `vlib/v/checker/tests/*.vv` * `vlib/v/parser/tests/*.vv` -> **Note** +> [!NOTE] > There are special folders, that compiler_errors_test.v will try to > run/compile with specific options: @@ -186,7 +186,7 @@ tests in the main V repository, for example: * `v vet vlib/v` - run a style checker. * `v test-self` (run self tests) in various compilation modes. -> **Note** +> [!NOTE] The VDOC test vdoc_file_test.v now also supports VAUTOFIX, which is useful, if you change anything inside cmd/tools/vdoc or vlib/v/doc/, or inside the modules that it depends on (like markdown). diff --git a/doc/docs.md b/doc/docs.md index 20c1e5e429deb7..335eb09ce2c1d7 100644 --- a/doc/docs.md +++ b/doc/docs.md @@ -6149,7 +6149,7 @@ specialised machine instructions, that do require a specific alignment to work. performance critical algorithms, you do not really need it, since the proper minimum alignment is CPU specific, and the compiler already usually will choose a good default for you. -> **Note** +> [!NOTE] > You can leave out the alignment factor, i.e. use just `@[aligned]`, in which case the compiler > will align a type to the maximum useful alignment for the target machine you are compiling for, > i.e. the alignment will be the largest alignment which is ever used for any data type on the diff --git a/examples/js_dom_cube/README.md b/examples/js_dom_cube/README.md index 9891243d46f5de..48ac4fcb96db9d 100644 --- a/examples/js_dom_cube/README.md +++ b/examples/js_dom_cube/README.md @@ -12,7 +12,7 @@ Then you can open `index.html` in your favorite browser. ### JS Server -> **NOTE**\ +> [!NOTE] > The JS server example in the following steps requires Node.js. > To install Node, please refer to the [download page](https://nodejs.org/en/download/) > or the installation via your operating systems [package manager](https://nodejs.org/en/download/package-manager). diff --git a/examples/js_dom_draw/README.md b/examples/js_dom_draw/README.md index db999997ecab91..fe03af2f200184 100644 --- a/examples/js_dom_draw/README.md +++ b/examples/js_dom_draw/README.md @@ -14,7 +14,7 @@ Then you can open `index.html` in your favorite browser. ### JS Server -> **NOTE**\ +> [!NOTE] > The JS server example in the following steps requires Node.js. > To install Node, please refer to the [download page](https://nodejs.org/en/download/) > or the installation via your operating systems [package manager](https://nodejs.org/en/download/package-manager). diff --git a/examples/js_dom_draw_bechmark_chart/README.md b/examples/js_dom_draw_bechmark_chart/README.md index a663cd59d3c963..ee6bce53fc95c9 100644 --- a/examples/js_dom_draw_bechmark_chart/README.md +++ b/examples/js_dom_draw_bechmark_chart/README.md @@ -4,7 +4,7 @@ ## Running the App -> **NOTE**\ +> [!NOTE] > The following steps require Node.js. > To install Node, please refer to the [download page](https://nodejs.org/en/download/) > or the installation via your operating systems [package manager](https://nodejs.org/en/download/package-manager). diff --git a/examples/regex/readme.md b/examples/regex/readme.md index 62a325e7c3a9be..5b414e91c1bb4e 100644 --- a/examples/regex/readme.md +++ b/examples/regex/readme.md @@ -4,7 +4,7 @@ There are 2 ways to do regex: a) using the native module called `regex` b) using an exteranl module called `pcre`, which wraps the C library pcre. -> **Note** +> [!NOTE] > You need to first do: `v install pcre`, for the `pcre` module to work. You can find examples of both in this directory. diff --git a/tutorials/building_a_simple_web_blog_with_vweb/README.md b/tutorials/building_a_simple_web_blog_with_vweb/README.md index 26135053571a1f..e3a723efbb9403 100644 --- a/tutorials/building_a_simple_web_blog_with_vweb/README.md +++ b/tutorials/building_a_simple_web_blog_with_vweb/README.md @@ -16,7 +16,7 @@ The benefits of using V for web: is enough. - Fast development without any boilerplate. -> **Note** +> [!NOTE] > V and Vweb are at a very early stage and are changing rapidly. The code is available [here](./code/blog). @@ -411,4 +411,4 @@ app is run you will see the articles created from the previous executions To be continued... -For an example of a more sophisticated web app written in V, check out Vorum: https://github.com/vlang/vorum \ No newline at end of file +For an example of a more sophisticated web app written in V, check out Vorum: https://github.com/vlang/vorum