Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.

Commit

Permalink
Docs working for icon-button element
Browse files Browse the repository at this point in the history
  • Loading branch information
guillemcordoba committed Oct 1, 2024
1 parent f7f4eeb commit 58c1b70
Show file tree
Hide file tree
Showing 15 changed files with 2,413 additions and 1,303 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ Enter the nix shell by running this in the root folder of the repository:

```bash
nix develop
npm install
pnpm install
```

**Run all the other instructions in this README from inside this nix shell, otherwise they won't work**.

## Running 2 agents

```bash
npm start
pnpm start
```

This will create a network of 2 nodes connected to each other and their respective UIs.
It will also bring up the Holochain Playground for advanced introspection of the conductors.

## Running the backend tests
## Running the tests

```bash
npm test
pnpm test
```

## Bootstrapping a network
Expand Down
161 changes: 80 additions & 81 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,87 +1,86 @@
import { withMermaid } from 'vitepress-plugin-mermaid';
import fs from 'fs';
import { withMermaid } from 'vitepress-plugin-mermaid';

// https://vitepress.dev/reference/site-config
// Uncomment this to enable mermaid inside your site when this is solved: https://github.com/mermaid-js/mermaid/issues/4320
// export default withMermaid({
export default ({
vue: {
template: {
compilerOptions: {
// treat all tags with a dash as custom elements
isCustomElement: (tag) => tag.includes("-"),
},
},
},
vite: {
optimizeDeps: {
include: [
'mermaid'
]
}
},
base: "/notifications",
title: "@darksoil-studio/notifications",
description: "Notifications zome for holochain apps",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
export default {
vue: {
template: {
compilerOptions: {
// treat all tags with a dash as custom elements
isCustomElement: tag => tag.includes('-'),
},
},
},
vite: {
optimizeDeps: {
include: ['mermaid'],
},
},
base: '/notifications',
title: '@darksoil-studio/notifications',
description: 'Notifications zome for holochain apps',
themeConfig: {
// https://vitepress.dev/reference/default-theme-config

sidebar: [
{
text: "Setup",
link: "/setup.md",
},
{
text: "API Reference",
items: [
{
text: "Integrity Zome",
link: "/backend/doc/notifications_integrity/index.html",
target: "_blank",
},
{
text: "Coordinator Zome",
link: "/backend/doc/notifications/index.html",
target: "_blank",
},
{
text: "Frontend",
items: [
{
text: "NotificationsStore",
link: "/notifications-store.md",
},
{
text: "Elements",
items: fs.readdirSync("./elements").filter(file => file.endsWith('.md')).map(el =>
({
text: el.split('.md')[0],
link: `/elements/${el}`,
}),
),
},
],
},
],
},
],
sidebar: [
{
text: 'Setup',
link: '/setup.md',
},
{
text: 'API Reference',
items: [
{
text: 'Integrity Zome',
link: '/backend/doc/notifications_integrity/index.html',
target: '_blank',
},
{
text: 'Coordinator Zome',
link: '/backend/doc/notifications/index.html',
target: '_blank',
},
{
text: 'Frontend',
items: [
{
text: 'NotificationsStore',
link: '/notifications-store.md',
},
{
text: 'Elements',
items: fs
.readdirSync('./elements')
.filter(file => file.endsWith('.md'))
.map(el => ({
text: el.split('.md')[0],
link: `/elements/${el}`,
})),
},
],
},
],
},
],

socialLinks: [
{
icon: "github",
link: "https://github.com/darksoil-studio/ notifications",
},
],
search: {
provider: 'local'
}
},
head: [
[
'script',
{},
// Synchronize the vitepress dark/light theme with the shoelace mode
`
socialLinks: [
{
icon: 'github',
link: 'https://github.com/darksoil-studio/notifications',
},
],
search: {
provider: 'local',
},
},
head: [
[
'script',
{},
// Synchronize the vitepress dark/light theme with the shoelace mode
`
function syncTheme() {
const isDark = document.documentElement.classList.contains('dark');
const isShoelaceDark = document.documentElement.classList.contains('sl-theme-dark');
Expand All @@ -96,7 +95,7 @@ export default ({
});
attrObserver.observe(document.documentElement, {attributes: true});
syncTheme();
`
]
],
});
`,
],
],
};
Loading

0 comments on commit 58c1b70

Please sign in to comment.