Skip to content

Commit

Permalink
docs: update deprecated blockquote highlight syntax (#19974)
Browse files Browse the repository at this point in the history
  • Loading branch information
ttytm committed Nov 23, 2023
1 parent 2a6c1d9 commit c805154
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions TESTS.md
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion doc/docs.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/js_dom_cube/README.md
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion examples/js_dom_draw/README.md
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion examples/js_dom_draw_bechmark_chart/README.md
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion examples/regex/readme.md
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions tutorials/building_a_simple_web_blog_with_vweb/README.md
Expand Up @@ -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).
Expand Down Expand Up @@ -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
For an example of a more sophisticated web app written in V, check out Vorum: https://github.com/vlang/vorum

0 comments on commit c805154

Please sign in to comment.