-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
107 lines (81 loc) · 3.5 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: Learning @ RENware Software Systems
site_author: 'Petre Iordanescu, RENware Software Systems'
copyright: 'Copyright (c) RENware Software Systems'
nav:
- Home: 'index.md'
- Learning catalog: 'learning_catalog.md'
- About platform: 'about.md'
- RENware Software Systems: 'http://www.renware.eu'
#- Full TLP Manual (PDF): 'pdfs/print_page.html/print_page.pdf' #NOTE_no_print_site_in_project
markdown_extensions:
- admonition
- tables
- pymdownx.details
- pymdownx.superfences:
custom_fences: #NOTE: is very important to respect syntax ref `-` character at beginning of items (otherwise not right JSON result !)
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- footnotes
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- def_list
- attr_list
- md_in_html
- pymdownx.tasklist:
custom_checkbox: true
#NOTE required to render `mermaid` diagrams
extra_javascript:
- optionalConfig.js
- https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js
- extra-loader.js
plugins:
- search
- include-markdown
#- pdf-export #NOTE this version does not render mermaid in PDF docs
#- print-site: # NO PRINT SITE in `project` #NOTE_no_print_site_in_project
#add_to_navigation: true #NOTE_no_print_site_in_project
#print_page_title: 'Full ArtK Manual' #NOTE_no_print_site_in_project
#add_full_urls: true #NOTE_no_print_site_in_project
#add_table_of_contents: true #NOTE_no_print_site_in_project
- pdf-with-js:
enable: true
- git-revision-date-localized #NOTE plugin that enables displaying the date of the last git modification of a page - see `https://github.com/timvink/mkdocs-git-revision-date-localized-plugin`
#NOTE provide material theme
theme:
logo: pictures/REN_TLP_logo.png
name: material
features:
- navigation.tabs #NOTE level 2 on left navigation side bar, level 1 on top navigation bar
- navigation.tracking
- navigation.tabs.sticky
- navigation.path
- toc.integrate #NOTE integrate TOC in left navbar
#- navigation.footer #NOTE do not enable this. It will show "Next & Prev" links on footer, useless for this portal...
palette:
primary: deep purple # see https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/ for other color options
icon:
admonition:
note: fontawesome/solid/note-sticky
abstract: fontawesome/solid/book
info: fontawesome/solid/circle-info
tip: fontawesome/solid/bullhorn
success: fontawesome/solid/check
question: fontawesome/solid/circle-question
warning: fontawesome/solid/triangle-exclamation
failure: fontawesome/solid/bomb
danger: fontawesome/solid/skull
bug: fontawesome/solid/robot
example: fontawesome/solid/flask
quote: fontawesome/solid/quote-left
#NOTE or can use readthedocs theme but should check mermaid diagrams
# theme: readthedocs
#NOTE directory where start to search or markdown sources
docs_dir: './doc_src'
#NOTE root directory where to be generated portal (should be `./static_portal`)
site_dir: './static_portal'
#NOTE other useful configurations
use_directory_urls: false # allow link between pages to work properly when used as OFFLINE deployment (ie, static site an "callable" as `file:///...`)