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
The [utPLSQL website](https://utplsql.github.io) is generated using [MkDocs](https://www.mkdocs.org/) and [material theme](https://squidfunk.github.io/mkdocs-material)
5
4
[Mike](https://github.com/jimporter/mike) is used for versioning of documentation see also [this page](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/)
6
5
6
+
## How to make an announcement post.
7
+
8
+
- Create a new post file in the [docs/_posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/main/docs/_posts) directory with the file name of `YYYY-MM-DD-Blog-Post-Name.md` This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be editing with any text editor although there are many offline and online editors for Markdown.
9
+
- Add new entry pointing to new announcement file to the start of `nav` section in `mkdocs.yml`
10
+
- Add new entry to the top of `index.md`
11
+
- Commit and push changes to develop branch
7
12
8
13
## Local setup
9
14
10
-
You will need to have python installed along with pip (see [this page](https://squidfunk.github.io/mkdocs-material/getting-started/))
15
+
If you want to generate and preview the website locally, you will need to have [python and pip installed](https://squidfunk.github.io/mkdocs-material/getting-started/))
11
16
12
-
Once you have pytin and pip installed you will need to install the three components:
17
+
To install mkdocs required components, you need to execute the below commands from command line:
Once installed you can use following commands from command line:
21
26
22
27
`mkdocs serve` - will stat a local server, so you can see the web page generated locally and tet real-time updates to documentation
23
-
`mkdocs gh-deploy` - will deploy changed documentation into repository (if you have privileges).
24
-
25
28
29
+
The pages are automatically generated on every commit to the `main` branch.
30
+
If however you would need to generate pages manually from your local copy, use the command:
31
+
`mkdocs gh-deploy`.
26
32
The generated web pages are hen visible at [utplsql.org](https://utPLSQL.org).
27
33
28
34
Individual project documentation pages are deployed separately from the main organization page.
@@ -37,24 +43,3 @@ Example commands to use are:
37
43
-`mike deploy -p develop` - to deploy and push documentation for develop branch
38
44
-`mike deploy -p -u v3.1.12 latest` - to deploy and push documentation for version v3.1.12 and update the `latest` alias to point to that version
39
45
40
-
41
-
## How to make an announcement post.
42
-
43
-
- Create a File in the [docs/_posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/main/docs/_posts) directory with the file name of `YYYY-MM-DD-Blog-Post-Name.md` This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be editing with any text editor although there are many offline and online editors for Markdown.
44
-
- Add new entry pointing to new announcement file to the start of `nav` section in `mkdocs.yml`
45
-
- Add new entry to the top of `index.md`
46
-
47
-
## How to preview site locally
48
-
49
-
Jekyll will allow you to preview the site locally doing the following:
0 commit comments