You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ All contributions are subject to the
16
16
# Markdown Flavor
17
17
The docs are written in standard markdown, not GitHub Flavored markdown. There are lots of extensions available though. Most of the extensions provided by [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/) are enabled except those only available to paying sponsors and a few that don't make sense in this environment.
18
18
19
-
!!! note
20
-
The conversion process that moved the documentation from the Confluence Wiki used equals signs `=====` and dashes `----` to denote headers. The new infrastructure renders those correctly but they do not get added to the page's table of contents. Going forward, you should always use hash signs `#`, `##`, `###`, etc to denote headers.
19
+
> [!NOTE]
20
+
>The conversion process that moved the documentation from the Confluence Wiki used equals signs `=====` and dashes `----` to denote headers. The new infrastructure renders those correctly but they do not get added to the page's table of contents. Going forward, you should always use hash signs `#`, `##`, `###`, etc to denote headers.
21
21
22
22
# Dynamic Documentation
23
23
@@ -57,10 +57,10 @@ $
57
57
58
58
The next time you want to test, you can just activate the virtual environment without needing to install the dependencies again. The `.venv` directory is already in the `.gitignore` file.
59
59
60
-
You'll also need the [`gh`](https://cli.github.com) tool to pull down the dynamic documentaiton from the CreateDocs job.
61
-
62
-
**NOTE:** The documentation build process no longer uses the `mike` python package.
60
+
You'll also need the [`gh`](https://cli.github.com) tool to pull down the dynamic documentation from the CreateDocs job.
63
61
62
+
> [!NOTE]
63
+
> The documentation build process no longer uses the `mike` python package.
64
64
65
65
# Building and Testing the Documentation
66
66
@@ -73,7 +73,7 @@ $ git clone -b main https://github.com/asterisk/documentation
73
73
$ cd documentation
74
74
```
75
75
76
-
Create a `Makefile.inc` file with some configuration variables. This file must NOT be checked in. Here are the contents to use:
76
+
Create a `Makefile.inc` file with some configuration variables. This file must **not** be checked in. Here are the contents to use:
77
77
78
78
```
79
79
# BUILD_DIR := <somepath> # Defaults to ./temp
@@ -150,7 +150,7 @@ Building branches does need at least a skeleton static layout so `static-setup`
150
150
$ make BRANCHES=18,20
151
151
```
152
152
153
-
If you only want the skeketon static documentation, you can add `NO_STATIC=yes` to that command line...
153
+
If you only want the skeleton static documentation, you can add `NO_STATIC=yes` to that command line...
0 commit comments