Skip to content

Commit 9230171

Browse files
committed
add toc
1 parent 540ad9b commit 9230171

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

README.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,36 @@
4545
</p>
4646
</div>
4747

48+
<!-- TABLE OF CONTENTS -->
49+
<details>
50+
<summary>🏁 Table of Contents</summary>
51+
<ol>
52+
<li>
53+
<a href="#-getting-started">⚡ Getting Started</a>
54+
<ul>
55+
<li><a href="#-installation">🔋 Installation</a></li>
56+
<li><a href="#-relationship-with-zenml">👨‍👦 Relationship with ZenML</a></li>
57+
<li><a href="#-deploying-the-dashboard">🪐 Deploying the dashboard</a></li>
58+
</ul>
59+
</li>
60+
<li>
61+
<a href="#-user-experience">🏄 User Experience</a>
62+
<ul>
63+
<li><a href="#-log-in">🔐 Log In</a></li>
64+
<li><a href="#-homepage">🏠 Home Page</a></li>
65+
<li><a href="#-pipeline-stacks-and-components">🗂 Pipeline, Stacks and Components</a></li>
66+
</ul>
67+
</li>
68+
<li><a href="#-contributing-and-community">🙌 Contributing</a></li>
69+
<li><a href="#-meet-the-team">👩‍👩‍👧‍👦 Meet the Team</a></li>
70+
<li><a href="#-getting-help">🆘 Getting Help</a></li>
71+
<li><a href="#-license">📜 License</a></li>
72+
</ol>
73+
</details>
74+
75+
<br />
76+
77+
4878
# ⚡ Getting Started
4979

5080
## 🔋 Installation
@@ -121,16 +151,16 @@ However, the option to deploy standalone is also available. `yarn build` creates
121151

122152
Just don't forget to the set the `REACT_APP_BASE_API_URL` environment variable!
123153

124-
# :bowtie: User Experience
154+
# 🏄 User Experience
125155

126-
## Log In
156+
## 🔐 Log In
127157

128158
![img](./assets/screenshot-login.png)
129159

130-
## Home Page
160+
## 🏠 Home Page
131161
![img](./assets/screenshot-home.png)
132162

133-
## Pipelines, Stacks and Components
163+
## 🗂 Pipelines, Stacks and Components
134164
![img](./assets/dashboard.gif)
135165

136166

0 commit comments

Comments
 (0)