Skip to content

Commit

Permalink
Create a custom sidebar
Browse files Browse the repository at this point in the history
This contains many dummy links while we draft this out.
  • Loading branch information
ch1bo committed May 6, 2024
1 parent 4e53f5c commit 44a2d1c
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 7 deletions.
7 changes: 0 additions & 7 deletions docs/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,3 @@ see also sections 7, 8 and 9 of the [Apache 2.0 License][license].

[known-issues]: ../known-issues
[license]: https://github.com/input-output-hk/hydra/blob/master/LICENSE

```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```
2 changes: 2 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ const config = {
docs: {
editUrl,
editLocalizedFiles: true,
sidebarPath: require.resolve("./sidebar.js"),
sidebarCollapsible: false,
},
blog: {
path: "adr",
Expand Down
104 changes: 104 additions & 0 deletions docs/sidebar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
module.exports = {
userDocumentation: [
{
type: "doc",
label: "Welcome",
id: "getting-started/index",
},
{
type: "html",
value: "<small><b>Tutorials</b></small>",
defaultStyle: true,
},
{
type: "link",
href: "/",
label: "Quick Start",
},
{
type: "doc",
id: "tutorial/index",
label: "Open a head on testnet",
},
{
type: "html",
value: "<small><b>Core Concepts</b></small>",
defaultStyle: true,
},
{
type: "link",
href: "/",
label: "Protocol overview",
},
"known-issues",
"faq",
{
type: "html",
value: "<small><b>Documentation</b></small>",
defaultStyle: true,
},
{
type: "link",
href: "/",
label: "Configuration",
},
{
type: "link",
href: "/",
label: "Reference scripts",
},
{
type: "link",
href: "/",
label: "Head parameters",
},
{
type: "link",
href: "/",
label: "Commit funds",
},
{
type: "category",
label: "How to ...",
collapsed: true,
collapsible: true,
items: [
{
type: "link",
href: "/",
label: "Run Hydra on mainnet",
},
{
type: "link",
href: "/",
label: "Use Hydra in a DApp",
},
{
type: "link",
href: "/",
label: "Commit a script to a head",
},
],
},
{
type: "html",
value: "<small><b>Reference</b></small>",
defaultStyle: true,
},
{
type: "link",
href: "https://github.com/input-output-hk/hydra/releases",
label: "Release notes",
},
{
type: "link",
href: "/api-reference",
label: "API reference",
},
{
type: "link",
href: "/benchmarks",
label: "Benchmarks",
},
],
};

0 comments on commit 44a2d1c

Please sign in to comment.