Skip to content

Commit 84268ee

Browse files
DariuszDeptaDariuszDepta
committed
Revert "Deploy website - based on caea3d60abf9c9b413311bca8d6d8107c122cd78"
This reverts commit 728da3a.
1 parent 728da3a commit 84268ee

File tree

202 files changed

+6206
-2672
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+6206
-2672
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Deploy
2+
3+
on:
4+
# Runs on pushes targeting the `main` branch.
5+
push:
6+
branches: [main]
7+
8+
# Allows to run this workflow manually from the Actions tab.
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: pages
21+
cancel-in-progress: false
22+
23+
jobs:
24+
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
name: Build
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v5
32+
with:
33+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
34+
35+
- name: Setup Node
36+
uses: actions/setup-node@v5
37+
with:
38+
node-version: 20
39+
cache: npm
40+
41+
- name: Setup Pages
42+
uses: actions/configure-pages@v5
43+
44+
- name: Install dependencies
45+
run: npm ci
46+
47+
- name: Build with VitePress
48+
run: npm run docs:build
49+
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v3
52+
with:
53+
path: .vitepress/dist
54+
55+
# Deployment job
56+
deploy:
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
needs: build
61+
runs-on: ubuntu-latest
62+
name: Deploy
63+
steps:
64+
- name: Deploy to GitHub Pages
65+
id: deployment
66+
uses: actions/deploy-pages@v4

‎.gitignore‎

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

‎.nojekyll‎

Whitespace-only changes.

‎.vitepress/config.mts‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import {withMermaid} from "vitepress-plugin-mermaid";
2+
3+
export default withMermaid({
4+
lang: 'en-US',
5+
base: '/',
6+
title: "CosmWasm Docs",
7+
description: "User guide for CosmWasm smart contract developers",
8+
head: [['link', {rel: 'icon', href: '/cosmwasm-small.svg'}]],
9+
lastUpdated: true,
10+
themeConfig: {
11+
logo: '/cosmwasm-small.svg',
12+
nav: [
13+
{
14+
text: 'Chapters', items: [
15+
{text: 'Welcome', link: '/guide/welcome'},
16+
{
17+
text: 'CosmWasm Core',
18+
items: [
19+
{text: 'Introduction', link: '/guide/cosmwasm-core/introduction'},
20+
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
21+
{text: 'Entrypoints', link: '/guide/cosmwasm-core/entrypoints/entrypoints'},
22+
{text: 'Architecture', link: '/guide/cosmwasm-core/architecture/architecture'},
23+
{text: 'Conventions', collapsed: true, link: '/guide/cosmwasm-core/conventions/conventions'}
24+
]
25+
}]
26+
},
27+
],
28+
sidebar: [
29+
{text: 'Welcome', link: '/guide/welcome'},
30+
{
31+
text: 'CosmWasm Core', collapsed: true,
32+
items: [
33+
{text: 'Introduction', link: '/guide/cosmwasm-core/introduction'},
34+
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
35+
{
36+
text: 'Entrypoints', collapsed: true, link: '/guide/cosmwasm-core/entrypoints/entrypoints',
37+
items: [
38+
{text: 'Instantiate', link: '/guide/cosmwasm-core/entrypoints/instantiate'},
39+
{text: 'Execute', link: '/guide/cosmwasm-core/entrypoints/execute'},
40+
{text: 'Query', link: '/guide/cosmwasm-core/entrypoints/query'},
41+
{text: 'Migrate', link: '/guide/cosmwasm-core/entrypoints/migrate'},
42+
{text: 'Sudo', link: '/guide/cosmwasm-core/entrypoints/sudo'},
43+
{text: 'Reply', link: '/guide/cosmwasm-core/entrypoints/reply'},
44+
]
45+
},
46+
{
47+
text: 'Architecture', collapsed: true, link: '/guide/cosmwasm-core/architecture/architecture',
48+
items: [
49+
{text: 'Semantics', link: '/guide/cosmwasm-core/architecture/semantics'},
50+
{text: 'Actor model', link: '/guide/cosmwasm-core/architecture/actor-model'},
51+
{text: 'Events', link: '/guide/cosmwasm-core/architecture/events'},
52+
{text: 'Gas', link: '/guide/cosmwasm-core/architecture/gas'},
53+
{text: 'Pinning', link: '/guide/cosmwasm-core/architecture/pinning'},
54+
{text: 'Transactions', link: '/guide/cosmwasm-core/architecture/transactions'},
55+
]
56+
},
57+
{
58+
text: 'Conventions', collapsed: true, link: '/guide/cosmwasm-core/conventions/conventions',
59+
items: [
60+
{text: 'Library feature', link: '/guide/cosmwasm-core/conventions/library-feature'},
61+
{text: 'Enum dispatch', link: '/guide/cosmwasm-core/conventions/enum-dispatch'},
62+
]
63+
},
64+
]
65+
},
66+
],
67+
search: {
68+
provider: 'local'
69+
}
70+
},
71+
mermaid: {},
72+
markdown: {
73+
math: true
74+
},
75+
srcDir: "pages"
76+
})

‎.vitepress/theme/components/ChapterLabel.vue‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<script setup>
2+
defineProps({
3+
label: {
4+
type: String,
5+
default: 'chapter',
6+
},
7+
bgColor: {
8+
type: String,
9+
default: 'var(--bg-medium-blue)'
10+
}
11+
})
12+
</script>
13+
14+
<template>
15+
<span class="label" :style="{backgroundColor: bgColor}">{{ label }}</span>
16+
</template>
17+
18+
<style scoped>
19+
.label {
20+
display: inline-block;
21+
color: white;
22+
border: none;
23+
padding: 2px 10px 2px 8px;
24+
border-radius: 12px;
25+
user-select: none;
26+
margin: 0 4px 20px 0;
27+
font-size: 0.9em;
28+
}
29+
</style>

‎.vitepress/theme/components/SectionLabel.vue‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<script setup>
2+
defineProps({
3+
chapter: {
4+
type: String,
5+
default: 'chapter',
6+
},
7+
section: {
8+
type: String,
9+
default: 'section',
10+
},
11+
bgChapter: {
12+
type: String,
13+
default: 'var(--bg-medium-blue)'
14+
},
15+
bgSection: {
16+
type: String,
17+
default: 'var(--bg-persian-pink)'
18+
}
19+
})
20+
</script>
21+
22+
<template>
23+
<span class="label" :style="{backgroundColor: bgChapter}">{{ chapter }}</span>
24+
<span class="label" :style="{backgroundColor: bgSection}">{{ section }}</span>
25+
</template>
26+
27+
<style scoped>
28+
.label {
29+
display: inline-block;
30+
color: white;
31+
border: none;
32+
padding: 2px 10px 2px 8px;
33+
border-radius: 12px;
34+
user-select: none;
35+
margin: 0 4px 20px 0;
36+
font-size: 0.9em;
37+
}
38+
</style>

‎.vitepress/theme/index.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import type { Theme } from 'vitepress'
2+
import DefaultTheme from 'vitepress/theme'
3+
import ChapterLabel from './components/ChapterLabel.vue'
4+
import SectionLabel from './components/SectionLabel.vue'
5+
import './style.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
enhanceApp({ app }) {
10+
app.component('ChapterLabel', ChapterLabel)
11+
app.component('SectionLabel', SectionLabel)
12+
}
13+
} satisfies Theme

‎.vitepress/theme/style.css‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:root {
2+
--bg-maya-blue: #70BCFF;
3+
--bg-medium-blue: #7954FF;
4+
--bg-persian-pink: #FC8ADC;
5+
--bg-congo-pink: #FF8B89;
6+
--bg-champagne: #FCECB2;
7+
8+
--dt-light-background: var(--bg-persian-pink);
9+
--dt-dark-background: var(--bg-medium-blue);
10+
--vp-home-hero-name-color: transparent;
11+
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, var(--dt-dark-background), var(--dt-light-background));
12+
--vp-code-font-size: 16px;
13+
--vp-custom-block-font-size: 16px;
14+
--vp-custom-block-code-font-size: 16px;
15+
--vp-custom-block-tip-text: #9A3412;
16+
--vp-custom-block-tip-bg: #FFF7ED;
17+
--vp-custom-block-tip-code-bg: #FFF7ED;
18+
}

‎404.html‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# CosmWasm User Guide
2+
3+
**A documentation-focused website for CosmWasm technologies**
4+
5+
## Overview
6+
7+
No matter if you're integrating CosmWasm with a chain, writing smart contracts, or just curious
8+
about what CosmWasm can do, you'll find everything you need here - from the core and wasmd,
9+
to storage, testing, IBC, and beyond.
10+
11+
## Website
12+
13+
### https://cosmwasm.github.io
14+
15+
## How is it made?
16+
17+
The deployed documentation is a [VitePress](https://vitepress.dev/) project hosted on GitHub pages.
18+
19+
## How can I run it locally?
20+
21+
You can just clone this repository and run the following commands:
22+
23+
```shell
24+
$ npm install
25+
$ task serve
26+
```
27+
28+
You will now be able to visit the locally served website at http://localhost:5173/
29+
30+
## How can I contribute?
31+
32+
Clone this repo, commit your changes to a new branch, push and open a new PR.

0 commit comments

Comments
 (0)