Skip to content

Commit 420fee2

Browse files
santillandsantilland
committed
adding initial set of docs based on vitepress
1 parent 9e11ecc commit 420fee2

File tree

19 files changed

+1821
-0
lines changed

19 files changed

+1821
-0
lines changed

‎.github/workflows/deploy_docs.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .github/workflows/deploy_docs.yml
2+
name: Deploy docs for main branch
3+
on:
4+
push:
5+
branches:
6+
- main
7+
jobs:
8+
deploy-docs:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
pages: write
13+
pull-requests: write
14+
steps:
15+
- uses: actions/checkout@v3
16+
- run: |
17+
npm install
18+
npm run docs:build -- --base /${{ github.event.repository.name }}/
19+
- uses: JamesIves/github-pages-deploy-action@v4
20+
with:
21+
folder: ./docs/.vitepress/dist/
22+
branch: gh-pages

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.vitepress/dist
2+
.vitepress/cache

‎.vitepress/config.mjs‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "eodash ecosystem",
6+
description: "Central documentation point for all aspects that make up the eodash ecosystem",
7+
themeConfig: {
8+
search: {
9+
provider: "local"
10+
},
11+
// https://vitepress.dev/reference/default-theme-config
12+
nav: [
13+
{ text: 'Home', link: '/' },
14+
{ text: 'Introduction', link: '/welcome' }
15+
],
16+
17+
sidebar: [
18+
{
19+
text: 'Introduction',
20+
items: [
21+
{ text: 'Welcome', link: '/welcome' },
22+
{ text: 'Preamble', link: '/preamble' },
23+
{ text: 'Components', link: '/components' },
24+
]
25+
},
26+
{
27+
text: 'Ecosystem setup',
28+
items: [
29+
{ text: 'First steps', link: '/first_steps' },
30+
{ text: 'Catalog backend', link: '/catalog' },
31+
{ text: 'eodash instance', link: '/eodash' },
32+
]
33+
},
34+
{
35+
text: 'Content',
36+
items: [
37+
{ text: 'Content integration', link: '/content' },
38+
{ text: 'Data', link: '/data' },
39+
{ text: 'Stories', link: '/stories' },
40+
]
41+
}
42+
],
43+
44+
socialLinks: [
45+
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
46+
]
47+
}
48+
})

‎.vitepress/theme/index.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import DefaultTheme from 'vitepress/theme'
4+
import './style.css'
5+
6+
/** @type {import('vitepress').Theme} */
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
}

‎.vitepress/theme/style.css‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attched to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: #4d73fe;
53+
--vp-c-brand-2: #738ce5;
54+
--vp-c-brand-3: #8e9ccb;
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: var(--vp-c-brand-1);
95+
}
96+
/**
97+
* Component: Custom Block
98+
* -------------------------------------------------------------------------- */
99+
100+
:root {
101+
--vp-custom-block-tip-border: transparent;
102+
--vp-custom-block-tip-text: var(--vp-c-text-1);
103+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
104+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
105+
}
106+
107+
/**
108+
* Component: Algolia
109+
* -------------------------------------------------------------------------- */
110+
111+
.DocSearch {
112+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
113+
}

‎assets/eodash_ecosystem.png‎

74.5 KB
Loading

‎catalog.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Catalog backend
2+
3+
This section is still needs to be filled! Please come by soon again, it is being worked on!

‎components.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Components
2+
3+
* [eodash](https://github.com/eodash/eodashg)
4+
- library for eodash client instance creation as well as web component release
5+
- extendable and configurable through widgets
6+
* [eodash_catalog](https://github.com/eodash/eodash_catalog)
7+
- library for creation of STAC catalog supported by eodash
8+
- supports multiple backends and services
9+
* [eodash-pages-template](https://github.com/eodash/eodash-pages-template)
10+
- template repo showing how to instantiate eodash as part of a vitepress application
11+
* [eodash-instance-template](https://github.com/eodash/eodash-instance-template)
12+
- template repo showing how to integrate eodash as package for building and extension of functionality into a vite based application
13+
* [catalog-template](https://github.com/eodash/catalog-template)
14+
- template repo with example setup for a catalog configuration and deployment as github pages
15+
* [eodash-docs](https://github.com/eodash/eodash-docs)
16+
- central location for eodash ecosystem documentation

‎content.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Content integration
2+
3+
We see at least three ways for contributing content to an instantiated eodash ecosystem:
4+
* Earth Observation Data
5+
* Stories
6+
* Additional static pages
7+
8+
Depending on the used setup an abstraction layer can have been placed on top to provide for example helpful user interfaces, like Content Management Systems (CMS) on top of the configuration and setup options, thus here we will talk about the "raw" git based content management.
9+
10+
More content to follow soon!

‎data.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Data
2+
3+
This section is still needs to be filled! Please come by soon again, it is being worked on!

0 commit comments

Comments
 (0)