Skip to content

Commit a75c597

Browse files
authored
Migrate to material theme (#1585)
* Migrate to material theme * Center image * Add config for rtd
1 parent 8a5a999 commit a75c597

24 files changed

+34
-1151
lines changed

docs/docs/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
<figure markdown>
12
![Hermes logo](img/hermes.png)
3+
</figure>
4+
25

36
Hermes is a message broker that greatly simplifies communication between services using publish-subscribe pattern.
47
It is HTTP-native, exposing REST endpoints for message publishing as well as pushing messages to subscribers REST endpoints.

docs/theme/css/bootstrap/css/bootstrap-theme.min.css

-6
This file was deleted.

docs/theme/css/bootstrap/css/bootstrap.min.css

-6
This file was deleted.
Binary file not shown.

docs/theme/css/bootstrap/fonts/glyphicons-halflings-regular.svg

-288
This file was deleted.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/theme/css/bootstrap/js/bootstrap.min.js

-7
This file was deleted.

docs/theme/css/font-awesome/css/font-awesome.min.css

-4
This file was deleted.
Binary file not shown.
Binary file not shown.

docs/theme/css/font-awesome/fonts/fontawesome-webfont.svg

-655
This file was deleted.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/theme/css/highlight-default.css

-77
This file was deleted.

docs/theme/js/base.js

-4
This file was deleted.

docs/theme/js/highlight.min.js

-3
This file was deleted.

docs/theme/js/jquery-2.2.0.min.js

-4
This file was deleted.

docs/theme/main.html

-87
This file was deleted.

mkdocs.yml

+9-10
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,20 @@ repo_url: https://github.com/allegro/hermes
66

77
docs_dir: docs/docs
88
theme:
9-
name: null
10-
custom_dir: docs/theme
11-
12-
extra_css:
13-
- styles.css
9+
name: material
10+
palette:
11+
primary: white
12+
logo: 'img/hermes-mini.png'
13+
features:
14+
- navigation.sections
1415

1516
markdown_extensions:
1617
- toc:
1718
anchorlink: true
19+
- attr_list
20+
- md_in_html
1821

19-
extra:
20-
version: '2.1.5'
21-
brand_image: 'img/hermes-mini.png'
22-
23-
pages:
22+
nav:
2423
- Home: 'index.md'
2524
- 'Quickstart': 'quickstart.md'
2625
- Overview:

readthedocs.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-20.04
11+
tools:
12+
python: "3.9"
13+
14+
mkdocs:
15+
configuration: mkdocs.yml
16+
17+
# Optionally declare the Python requirements required to build your docs
18+
python:
19+
install:
20+
- requirements: requirements.txt

requirements.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
mkdocs==1.4.0
2+
mkdocs-material==8.5.6

0 commit comments

Comments
 (0)