Skip to content

Commit 1aecf6d

Browse files
angelo-vangelo-v
committed
feat(homepage): include element reference
1 parent 8d0ce36 commit 1aecf6d

File tree

13 files changed

+147
-13
lines changed

13 files changed

+147
-13
lines changed

‎docs/elements/components/pos-navigation/bar/readme.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# pos-navigation-bar
2+
3+
<!-- Auto Generated Below -->
4+
5+
6+
## Properties
7+
8+
| Property | Attribute | Description | Type | Default |
9+
| ------------------ | -------------------- | ----------- | --------- | ----------- |
10+
| `current` | -- | | `Thing` | `undefined` |
11+
| `searchIndexReady` | `search-index-ready` | | `boolean` | `undefined` |
12+
13+
14+
## Events
15+
16+
| Event | Description | Type |
17+
| ----------------- | ----------- | ------------------ |
18+
| `pod-os:navigate` | | `CustomEvent<any>` |
19+
20+
21+
## Dependencies
22+
23+
### Used by
24+
25+
- [pos-navigation](..)
26+
27+
### Depends on
28+
29+
- [pos-make-findable](../../pos-make-findable)
30+
31+
### Graph
32+
```mermaid
33+
graph TD;
34+
pos-navigation-bar --> pos-make-findable
35+
pos-make-findable --> pos-resource
36+
pos-make-findable --> pos-label
37+
pos-resource --> ion-progress-bar
38+
pos-navigation --> pos-navigation-bar
39+
style pos-navigation-bar fill:#f9f,stroke:#333,stroke-width:4px
40+
```
41+
42+
----------------------------------------------
43+
44+
*Built with [StencilJS](https://stenciljs.com/)*

‎docs/elements/components/pos-navigation/readme.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# pos-navigation
2+
3+
<!-- Auto Generated Below -->
4+
5+
6+
## Properties
7+
8+
| Property | Attribute | Description | Type | Default |
9+
| -------- | --------- | ----------------------------------- | -------- | ------- |
10+
| `uri` | `uri` | Initial value of the navigation bar | `string` | `''` |
11+
12+
13+
## Events
14+
15+
| Event | Description | Type |
16+
| ------------- | ----------- | ------------------ |
17+
| `pod-os:init` | | `CustomEvent<any>` |
18+
| `pod-os:link` | | `CustomEvent<any>` |
19+
20+
21+
## Dependencies
22+
23+
### Used by
24+
25+
- [pos-app-browser](../../apps/pos-app-browser)
26+
27+
### Depends on
28+
29+
- [pos-navigation-bar](bar)
30+
- [pos-rich-link](../pos-rich-link)
31+
32+
### Graph
33+
```mermaid
34+
graph TD;
35+
pos-navigation --> pos-navigation-bar
36+
pos-navigation --> pos-rich-link
37+
pos-navigation-bar --> pos-make-findable
38+
pos-make-findable --> pos-resource
39+
pos-make-findable --> pos-label
40+
pos-resource --> ion-progress-bar
41+
pos-rich-link --> pos-label
42+
pos-rich-link --> pos-description
43+
pos-rich-link --> pos-resource
44+
pos-app-browser --> pos-navigation
45+
style pos-navigation fill:#f9f,stroke:#333,stroke-width:4px
46+
```
47+
48+
----------------------------------------------
49+
50+
*Built with [StencilJS](https://stenciljs.com/)*

‎docs/elements/readme.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# @pod-os/elements
2+
3+
Reference documentation

‎homepage/.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
site/
22
docs/assets/
3-
.cache
3+
.cache
4+
docs/reference/elements/

‎homepage/build/prepare.nu‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
#!/usr/bin/env nu
22

3-
rsync --recursive ../assets/ ./docs/assets/
3+
rsync --recursive --delete ../assets/ ./docs/assets/
4+
5+
rsync --recursive --delete ../docs/elements ./docs/reference
6+
7+
ls ./docs/reference/elements/**/readme.md
8+
| each {|f|
9+
$f.name
10+
let new = ($f.name | str replace 'readme.md' 'index.md')
11+
mv $f.name $new
12+
}

‎homepage/docs/.nav.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
nav:
3+
- Home: index.md
4+
- getting-started
5+
- reference
6+
- tutorials
7+
- contributing

‎homepage/docs/contributing/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Contributing
3+
---
4+
15
# Contributing to PodOS
26

37
Check out our [repository on GitHub](https://github.com/pod-os/PodOS) and

‎homepage/docs/overrides/home.html.j2‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</p>
1212
<p class="buttons">
1313
<a href="getting-started/" class="md-button md-button--primary">Get Started</a>
14-
<a href="contributing/" class="md-button">Contributing</a>
14+
<a href="reference/" class="md-button">Reference</a>
1515
</p>
1616
</div>
1717
</section>

‎homepage/docs/reference/.nav.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
title: Reference
2+
3+
preserve_directory_names: true
4+
5+
nav:
6+
- index.md
7+
- '@pod-os/elements':
8+
- elements/index.md
9+
- elements/apps
10+
- elements/components
11+
- '@pod-os/core':
12+
- core/index.md

‎homepage/docs/reference/core/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# @pod-os/core
2+
3+
Coming soon

0 commit comments

Comments
 (0)