Skip to content

Commit

Permalink
Set up a skeleton doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
BT-Creator committed Jul 22, 2024
1 parent 9dddbcb commit 8cc5754
Show file tree
Hide file tree
Showing 16 changed files with 235 additions and 79 deletions.
104 changes: 89 additions & 15 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,28 +1,102 @@
import { defineConfig } from 'vitepress'

const projectSidebar = { text: "Project", items: [
{
text: 'Goal',
link: '/project/goal'
},
{
text: 'Audience',
link: '/project/audience'
},
{
title: "Lexicon",
link: "/project/lexicon"
},
{
text: "Team",
link: "/team"
}
]};

const loamaSidebar = {
text: 'Loama',
items: [
{
text: 'Design',
link: '/loama/design.md'
},
{
text: 'Development',
link: '/loama/development'
},
{
text: 'Feedback & Future suggestions',
link: '/loama/feedback'
}
]
};

const mockAppSidebar = {

}

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Loama",
description: "The documentation & handover website of the LOAMA project",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: '/loama-logo.svg',
socialLinks: [
{ icon: 'github', link: 'https://github.com/osoc24' },
{ icon: 'linkedin', link: 'https://www.linkedin.com/company/open-summer-of-code/posts/?feedView=all' },
],
search: {
provider: 'local'
},
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],

sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
{ text: 'Project', items: [
{ text: 'Why?', link: "/project/goal"},
{ text: 'For who?', link: "/project/audience"},
]},
{ text: 'Loama', items: [
{ text: 'Design', link: '/loama/design.md' },
{ text: 'Development', link: '/loama/development' },
{ text: "Feedback", link: "/loama/feedback" }
]},
{ text: "Mock Apps", items: [
{ text: "MockBook", link: "/toco/mockbook/index"},
{ text: "Docterapp", link: "/toco/doctorapp/index"}
]}
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
sidebar: {
'/project': [
projectSidebar,
{
...loamaSidebar,
collapsed: true
}

],
'/loama': [
{
...projectSidebar,
collapsed: true
},
loamaSidebar
],
'/toco': [
{
...projectSidebar,
collapsed: true
},
{
...loamaSidebar,
collapsed: true
}
]
},
}
})
36 changes: 26 additions & 10 deletions .vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,31 @@
* -------------------------------------------------------------------------- */

:root {
/** LOAMA Colors */
--solid-purple: rgb(124, 77, 255);
--solid-purple-50: rgb(124, 77, 255, 0.5);
--sonight-purple: #6200EA;
--soday-purple: #9F7EFF;
--off-black: #170D33;
--off-white: #F7F7F7;
--lama-gray: #DADADA;
--positive-green: #32BC65;
--error-red: rgb(222, 76, 89);
--error-red-50: rgba(222, 76, 89, 0.5);

/** VP Overrides */
--vp-c-white: var(--off-white);
--vp-c-black: var(--off-black);

--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);

--vp-c-brand-1: var(--vp-c-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-soft);
--vp-c-brand-1: var(--solid-purple);
--vp-c-brand-2: var(--soday-purple);
--vp-c-brand-3: var(--sonight-purple);
--vp-c-brand-soft: var(--solid-purple-50);

--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
Expand All @@ -64,10 +80,10 @@
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);

--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-1: var(--error-red);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
--vp-c-danger-soft: var(--error-red-50);
}

/**
Expand All @@ -94,14 +110,14 @@
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
var(--sonight-purple) 30%,
var(--soday-purple)
);

--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
var(--sonight-purple) 50%,
var(--soday-purple) 50%
);
--vp-home-hero-image-filter: blur(44px);
}
Expand Down
49 changes: 0 additions & 49 deletions api-examples.md

This file was deleted.

File renamed without changes.
10 changes: 5 additions & 5 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ layout: home
hero:
name: "Loama"
text: "The documentation & handover website of the LOAMA project"
tagline: My great project tagline
tagline: Making Solid access easier & understandable
actions:
- theme: brand
text: Markdown Examples
link: /markdown-examples
text: Introduction
link: /getting-started
- theme: alt
text: API Examples
link: /api-examples
text: Meet the team
link: /team

features:
- title: Feature A
Expand Down
Empty file added loama/design.md
Empty file.
Empty file added loama/development.md
Empty file.
Empty file added loama/feedback.md
Empty file.
Empty file added loama/index.md
Empty file.
Empty file added project/audience.md
Empty file.
Empty file added project/goal.md
Empty file.
Empty file added project/lexicon.md
Empty file.
78 changes: 78 additions & 0 deletions public/loama-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: page
---
<script setup lang="ts">
import {
VPTeamPage,
VPTeamPageTitle,
VPTeamMembers
} from 'vitepress/theme'

const members = [
{
avatar: 'https://www.github.com/yyx990803.png',
name: 'Evan You',
title: 'Creator',
links: [
{ icon: 'github', link: 'https://github.com/yyx990803' },
{ icon: 'twitter', link: 'https://twitter.com/youyuxi' }
]
},
]
</script>

<VPTeamPage>
<VPTeamPageTitle>
<template #title>
Our Team
</template>
<template #lead>
The development of VitePress is guided by an international
team, some of whom have chosen to be featured below.
</template>
</VPTeamPageTitle>
<VPTeamMembers
:members="members"
/>
</VPTeamPage>
Empty file added toco/doctorapp/index.md
Empty file.
Empty file added toco/mockbook/index.md
Empty file.

0 comments on commit 8cc5754

Please sign in to comment.