Skip to content

Commit fea5fab

Browse files
committed
rearange navigation and link to main docs with tabs
1 parent 25ec424 commit fea5fab

4 files changed

Lines changed: 26 additions & 7 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ jobs:
1515
- run: pip install mkdocs-material
1616
- run: pip install mkdocs-awesome-pages-plugin
1717
- run: pip install mkdocs-git-revision-date-localized-plugin
18+
- run: pip install mkdocs-redirects
1819
- run: mkdocs gh-deploy --force

docs/documentation/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: documentation
3+
---
4+
5+
#
6+
7+
<p align="center">
8+
<img width="500" src="https://raw.githubusercontent.com/BHoM/documentation/main/Images/logos/BHoM_Logo.png">
9+
</p>
10+
11+
<br/><br/>
12+
13+
## Documentation
14+
15+
For general documentation please see [BHoM documentation](https://bhom.xyz/documentation)
16+

docs/index.md renamed to docs/oM/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: BHoM Object Model Documentation
2+
title: Object Model Documentation
33
---
44

55
#
@@ -10,7 +10,7 @@ title: BHoM Object Model Documentation
1010

1111
<br/><br/>
1212

13-
## BHoM Object Model Documentation
13+
## Object Model Documentation
1414

1515
Welcome to the BHoM oM Documentation. This site contains the documentation of all the objects in the toolkits and repositories in the BHoM organisation part of the BHoM installer.
1616

mkdocs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: BHoM Object Model Documentation
22
copyright: Copyright &copy; 2018 - 2024 BHoM
3-
site_url: https://bhom.xyz/om_documentation/
4-
repo_url: https://github.com/BHoM/om_documentation
3+
site_url: https://bhom.xyz/api_documentation/
4+
repo_url: https://github.com/BHoM/api_documentation
55
edit_uri: edit/main/docs/
66

77
theme:
@@ -18,7 +18,7 @@ theme:
1818
features:
1919
- navigation.tracking
2020
- navigation.top
21-
- navigation.sections
21+
- navigation.tabs
2222
- content.action.edit
2323
- content.action.view
2424
- content.tabs.link # allows to link to specific Content tab. See https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
@@ -29,8 +29,10 @@ plugins:
2929
- git-revision-date-localized: # Displays date created/modified on the page. The below configurations are bugged, so only date modified works.
3030
enable_creation_date: true
3131
fallback_to_build_date: true
32-
33-
32+
- redirects:
33+
redirect_maps:
34+
'index.md': 'oM/index.md'
35+
'documentation/index.md': 'https://bhom.xyz/documentation/'
3436

3537
markdown_extensions:
3638
- attr_list # allows to add HTML/CSS attributes to almost every Markdown element, useful for e.g. aligning an image to the left/right (can't do centre though! use md_in_html instead)

0 commit comments

Comments
 (0)