runs-on:ubuntu-latest

steps:

-uses:actions/checkout@v4

with:

fetch-depth:0

-uses:actions/setup-python@v2

with:

python-version:3.x

The[utPLSQL website](https://utplsql.github.io) is generated using[MkDocs](https://www.mkdocs.org/) and[material theme](https://squidfunk.github.io/mkdocs-material)

[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/)

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

- Add new entry pointing to new announcement file to the start of`nav` section in`mkdocs.yml`

- Add new entry to the top of`index.md`

- Commit and push changes to develop branch

You will need tohave python installed along with pip (see[this page](https://squidfunk.github.io/mkdocs-material/getting-started/))

If you want togenerate and preview the website locally, you will need to have[python and pip installed](https://squidfunk.github.io/mkdocs-material/getting-started/))

Once you have pytin and pip installedyouwillneed toinstall thethree components:

To install mkdocs required components,you need toexecute thebelow commands from command line:

Once installed you can use following commands from command line:

`mkdocs serve` - will stat a local server, so you can see the web page generated locally and tet real-time updates to documentation

`mkdocs gh-deploy` - will deploy changed documentation into repository (if you have privileges).

The pages are automatically generated on every commit to the`main` branch.

If however you would need to generate pages manually from your local copy, use the command:

`mkdocs gh-deploy`.

The generated web pages are hen visible at[utplsql.org](https://utPLSQL.org).

Individual project documentation pages are deployed separately from the main organization page.

-`mike deploy -p develop` - to deploy and push documentation for develop branch

-`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

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

- Add new entry pointing to new announcement file to the start of`nav` section in`mkdocs.yml`

- Add new entry to the top of`index.md`

Jekyll will allow you to preview the site locally doing the following:

1.[Install Jekyll 3](https://jekyllrb.com/docs/installation/)

2.[Use Jekyll Serve](https://jekyllrb.com/docs/usage/)

^2024-02-19^

[version 3.1.14 released](_posts/2024-02-19-version3.1.14-released.md)

^2022-12-11^

[version 3.1.13 released](_posts/2022-12-11-version3.1.13-released.md)