Skip to content

Commit

Permalink
Update docs template
Browse files Browse the repository at this point in the history
  • Loading branch information
edoardocavazza committed Mar 18, 2024
1 parent bb60dec commit fa80618
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ lerna-debug.log*
.eslintcache

node_modules
public
/public
coverage
types
*.local
Expand Down
13 changes: 9 additions & 4 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ export default defineConfig({
base: '/quantum/',
outDir: '../public',

head: [['link', { rel: 'icon', href: 'https://www.chialab.it/favicon.png' }]],
head: [['link', { rel: 'icon', href: '/quantum/favicon.png' }]],

themeConfig: {
logo: 'https://raw.githubusercontent.com/chialab/dna/main/logo.svg',
logo: '/chialab.svg',

editLink: {
pattern: 'https://github.com/chialab/quantum/edit/main/docs/:path',
text: 'Suggest changes to this page',
},

// https://vitepress.dev/reference/default-theme-config
nav: [
Expand All @@ -32,7 +37,7 @@ export default defineConfig({
],
},
{
text: 'Chialab.io',
text: 'Chialab Open Source',
link: 'https://www.chialab.io',
},
],
Expand All @@ -43,7 +48,7 @@ export default defineConfig({
items: [
{ text: 'Why Quantum', link: '/guide/why-quantum' },
{ text: 'Features', link: '/guide/features' },
{ text: 'Getting started', link: '/guide/' },
{ text: 'Get started', link: '/guide/' },
{ text: 'Usage', link: '/guide/usage' },
{ text: 'Custom Elements', link: '/guide/custom-elements' },
],
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hero:
tagline: 'Custom elements composition made easy.'
actions:
- theme: brand
text: npm i @chialab/quantum
text: Get started
link: /guide/

- theme: alt
Expand Down
14 changes: 14 additions & 0 deletions docs/public/chialab.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa80618

Please sign in to comment.