Skip to content

Commit efbd70a

Browse files
committed
Adjusting v3.0.0-beta documentation to MkDocs
1 parent 523f36e commit efbd70a

File tree

1 file changed

+68
-6
lines changed

1 file changed

+68
-6
lines changed

mkdocs.yml

Lines changed: 68 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,79 @@
11
# Format documented here
22
# http://www.mkdocs.org/user-guide/configuration/
33

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

12-
pages:
13-
- Home: index.md
67+
plugins:
68+
- search
69+
- mike
70+
- git-revision-date-localized: # disable for offline docs
71+
enable_creation_date: true # disable for offline docs
72+
type: datetime # disable for offline docs
73+
74+
nav:
1475
- User Guide:
76+
- index.md
1577
- Installation: userguide/install.md
1678
- Getting Started: userguide/getting-started.md
1779
- Annotations: userguide/annotations.md
@@ -22,8 +84,8 @@ pages:
2284
- Upgrade utPLSQL: userguide/upgrade.md
2385
- Reporting:
2486
- Using reporters: userguide/reporters.md
25-
- Reporting errors: userguide/exception-reporting.md
2687
- Code coverage: userguide/coverage.md
88+
- Error handling and reporting: userguide/exception-reporting.md
2789
- About:
2890
- Project Details: about/project-details.md
2991
- License: about/license.md

0 commit comments

Comments
 (0)