mkdocs.yml 2.13 KB
Newer Older
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
# name of the website, with link, at the left of the navbar :
site_name: Porticapi
site_url: http://data.portic.fr
site_description: Documentation website for the porticapi project
# to get the 'Editer dans GitLab huma-num' link at the right of the navbar, when browsing documentation :
repo_url: https://gitlab.huma-num.fr/portic/porticapi/
repo_name: GitLab huma-num 
edit_uri: -/blob/master/docs/
  # 'blob' to open a read-only view, which supports anonymous access.
  # if you don't want the 'Edit' link, put edit_uri to ''
# choose and configure an installed mkdocs theme :
theme:
  # available themes : mkdocs (default), readthedocs
  name: mkdocs
  # style of the mkdocs theme : primary (default), dark, light
  nav_style: dark
  # localization of the theme only : en, fr, ...
  locale: fr
  # maximum depth of the navigation tree in the sidebar. Default: 2
  navigation_depth: 2
# extensions to regular markdown syntax : https://daringfireball.net/projects/markdown/
# and the Python-Markdown library syntax : https://python-markdown.github.io/
# available (installed) extensions : https://python-markdown.github.io/extensions/
markdown_extensions:
  # Python-Markdown extra : Abbreviations, Attribute Lists, Definition Lists, Fenced Code Blocks, Footnotes, Tables, Markdown in HTML
  - extra
  # Table of contents : place the [TOC] marker in markdown (useless, only here to configure max headers level. See also navigation_depth)
  - toc:
        # Base level for headers. Defaults to 1. Suppose the Markdown text for a page should not contain any headers higher than level 1 (<h1>)
        baselevel: 1
# path of source markdown files
docs_dir: 'docs'
33
34
# Extra CSS
extra_css: ['stylesheets/extra-css.css']
35
36
37
38
39
40
41
42
43
44
# output path of built HTML documentation
site_dir: 'manual'
# true for directory 'manual/' links, false for 'manual/index.html' links
use_directory_urls: false
# layout of the navbar (menu) :
# - 'Displayed title': 'markdown_file.md or external link'
nav:
  - 'Accueil': 'index.md'
  - 'Manuel utilisateur': 'usermanual.md'
  - 'Licence': 'agpl-3.0.md'
45
46
  - 'Code source': 'https://gitlab.huma-num.fr/portic/porticapi'
  - 'Demontrateur': http://apidemo.portic.fr/