Skip to content

Commit 4a0d952

Browse files
seanbrightgtjoseph
authored andcommitted
README.md: Use GFM and some speling corrextions.
1 parent 494824a commit 4a0d952

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ All contributions are subject to the
1616
# Markdown Flavor
1717
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.
1818

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.
2121
2222
# Dynamic Documentation
2323

@@ -57,10 +57,10 @@ $
5757

5858
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.
5959

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.
6361

62+
> [!NOTE]
63+
> The documentation build process no longer uses the `mike` python package.
6464
6565
# Building and Testing the Documentation
6666

@@ -73,7 +73,7 @@ $ git clone -b main https://github.com/asterisk/documentation
7373
$ cd documentation
7474
```
7575

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:
7777

7878
```
7979
# BUILD_DIR := <somepath> # Defaults to ./temp
@@ -150,7 +150,7 @@ Building branches does need at least a skeleton static layout so `static-setup`
150150
$ make BRANCHES=18,20
151151
```
152152

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...
154154

155155
```
156156
$ make BRANCHES=18,20 NO_STATIC=yes

0 commit comments

Comments
 (0)