Skip to content

Commit

Permalink
Modified the run scrip, added logos for sap and updated yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
RSAK56 committed May 20, 2024
1 parent a313ae7 commit dc74118
Show file tree
Hide file tree
Showing 11 changed files with 736 additions and 356 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "theme_common"]
path = theme_common
url = [email protected]:stakater/stakater-docs-mkdocs-theme.git
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ Install mkdocs-material and mermaid plugin:
$ pip3 install mkdocs-material mkdocs-mermaid2-plugin
```

Install mkdocs-include-markdown-plugin (if not installed by default and gives an error):

```bash
$ pip install mkdocs-include-markdown-plugin
```

Finally serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead:

```bash
Expand Down Expand Up @@ -77,3 +83,11 @@ Install [Tilt](https://docs.tilt.dev/index.html), then run:
```bash
$ tilt up
```

Files `main.html` and `404.html` are served from `theme_common` rather than override since they are to be consistent throughout. If anything changes they can be served via `theme_override`.

To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy paste bash file using sudo cmd file to your root directory and then run the following cmd:

```bash
$ chmod +x preparetheme sh
```
6 changes: 0 additions & 6 deletions custom_theme/404.html

This file was deleted.

5 changes: 0 additions & 5 deletions custom_theme/main.html

This file was deleted.

712 changes: 367 additions & 345 deletions mkdocs.yml

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions prepare_theme.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pip install -r theme_common/requirements.txt
python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme
python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml
1 change: 1 addition & 0 deletions theme_common
Submodule theme_common added at a17e7e
348 changes: 348 additions & 0 deletions theme_override/mkdocs.yml

Large diffs are not rendered by default.

File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dc74118

Please sign in to comment.