Skip to content

Commit e929a68

Browse files
committed
Adjusting v3.1.12 documentation to MkDocs
1 parent d4225de commit e929a68

File tree

1 file changed

+70
-7
lines changed

1 file changed

+70
-7
lines changed

mkdocs.yml

Lines changed: 70 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,93 @@
11
# Format documented here
22
# http://www.mkdocs.org/user-guide/configuration/
3+
# https://squidfunk.github.io/mkdocs-material/getting-started/
34

4-
site_name: utPLSQL
5-
site_description: utPLSQL Ultimate Unit Testing Framework for Oracle PL/SQL
6-
copyright: Copyright © 2016 - 2018 utPLSQL Team
5+
site_url: http://utPLSQL.org/
6+
site_name: utPLSQL-framework
7+
site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL & SQL
8+
copyright: Copyright © 2016 - 2022 utPLSQL Team
79
repo_url: https://github.com/utPLSQL/utPLSQL
8-
theme: mkdocs
10+
theme:
11+
name: material
12+
palette:
13+
# Palette toggle for light mode
14+
- media: "(prefers-color-scheme: light)"
15+
scheme: default
16+
toggle:
17+
icon: material/lightbulb-outline
18+
name: Switch to dark mode
19+
# Palette toggle for dark mode
20+
- media: "(prefers-color-scheme: dark)"
21+
scheme: slate
22+
toggle:
23+
icon: material/lightbulb
24+
name: Switch to light mode
25+
logo: assets/icon-transparent.png
26+
favicon: assets/favicon.png
27+
features:
28+
- navigation.instant # disable for offline docs
29+
# - navigation.indexes
30+
- navigation.tabs
31+
- navigation.tracking
32+
- toc.follow
33+
- toc.integrate
34+
- search.suggest
35+
- search.highlight
36+
extra:
37+
# homepage: http://jgebal.github.io/
38+
# homepage: http://utPLSQL.org/
39+
social:
40+
- icon: fontawesome/brands/twitter
41+
link: https://twitter.com/utPLSQL
42+
- icon: fontawesome/brands/slack
43+
link: https://join.slack.com/t/utplsql/shared_invite/zt-xwm68udy-4cF_3PNEyczYEbWr38W5ww
44+
- icon: fontawesome/brands/github
45+
link: https://github.com/utPLSQL
46+
- icon: fontawesome/solid/envelope
47+
link: mailto:utPLSQL@utPLSQL.org
48+
consent:
49+
title: Cookie consent
50+
description: >-
51+
We use cookies to recognize your repeated visits and preferences, as well
52+
as to measure the effectiveness of our documentation and whether users
53+
find what they're searching for. With your consent, you're helping us to
54+
make our documentation better.
55+
version: # disable for offline docs
56+
provider: mike # disable for offline docs
57+
markdown_extensions:
58+
- pymdownx.highlight:
59+
anchor_linenums: true
60+
- pymdownx.inlinehilite
61+
- pymdownx.snippets
62+
- pymdownx.superfences
63+
- toc:
64+
permalink: true
965
use_directory_urls: false
1066
strict: true
1167

68+
plugins:
69+
- search
70+
- mike
71+
- git-revision-date-localized: # disable for offline docs
72+
enable_creation_date: true # disable for offline docs
73+
type: datetime # disable for offline docs
74+
1275
nav:
13-
- Home: index.md
1476
- User Guide:
77+
- index.md
1578
- Installation: userguide/install.md
1679
- Getting Started: userguide/getting-started.md
1780
- Annotations: userguide/annotations.md
1881
- Expectations: userguide/expectations.md
1982
- Advanced data comparison: userguide/advanced_data_comparison.md
2083
- Running unit tests: userguide/running-unit-tests.md
2184
- Querying for test suites: userguide/querying_suites.md
22-
- Testing best pracitces: userguide/best-practices.md
85+
- Testing best practices: userguide/best-practices.md
2386
- Upgrade utPLSQL: userguide/upgrade.md
2487
- Reporting:
2588
- Using reporters: userguide/reporters.md
26-
- Reporting errors: userguide/exception-reporting.md
2789
- Code coverage: userguide/coverage.md
90+
- Error handling and reporting: userguide/exception-reporting.md
2891
- About:
2992
- Project Details: about/project-details.md
3093
- License: about/license.md

0 commit comments

Comments
 (0)