Skip to content

Commit

Permalink
Skeleton for website
Browse files Browse the repository at this point in the history
  • Loading branch information
tupui committed Aug 3, 2024
1 parent ee7477b commit 4fa70ff
Show file tree
Hide file tree
Showing 29 changed files with 16,585 additions and 22 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Soroban Versioning logo: representation of a planet with a circle and two
45 degrees parallel lines cutting it in the middle. Two small circles at the
intersection between the circle and the lines. This represent Git with
branches and merge commits](doc/svn-logo.svg)
branches and merge commits](web/website/static/img/logo.svg)

# Soroban Versioning

Expand Down
21 changes: 0 additions & 21 deletions doc/svn-logo.svg

This file was deleted.

20 changes: 20 additions & 0 deletions web/website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
29 changes: 29 additions & 0 deletions web/website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/).

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Netlify
3 changes: 3 additions & 0 deletions web/website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
8 changes: 8 additions & 0 deletions web/website/blog/2024-08-03-welcome/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
slug: welcome
title: Welcome
authors: pamphile
tags: [soroban]
---

Tansu is here!
5 changes: 5 additions & 0 deletions web/website/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pamphile:
name: Pamphile Roy
title: Maintainer of Tansu
url: https://github.com/tupui
image_url: https://avatars.githubusercontent.com/u/23188539
4 changes: 4 additions & 0 deletions web/website/blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
soroban:
label: soroban
permalink: /soroban
description: Soroban Smart Contract
8 changes: 8 additions & 0 deletions web/website/docs/developers/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Developers",
"position": 2,
"link": {
"type": "generated-index",
"description": "Developers' section."
}
}
5 changes: 5 additions & 0 deletions web/website/docs/developers/congratulations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Hello
5 changes: 5 additions & 0 deletions web/website/docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Welcome to Tansu!
125 changes: 125 additions & 0 deletions web/website/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
title: 'Tansu - Soroban Versioning',
tagline: 'Bringing Git hashes onto Stellar’s blockchain',
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://tansu.dev',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'tansu', // Usually your GitHub org/user name.
projectName: 'soroban-versioning', // Usually your repo name.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},

presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],

themeConfig: {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'Tansu',
logo: {
alt: 'Tansu Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Documentation',
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/tupui/soroban-versioning',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
// links: [
// {
// title: 'Docs',
// items: [
// {
// label: 'Documentation',
// to: '/docs/intro',
// },
// ],
// },
// {
// title: 'Community',
// items: [
// {
// label: 'Discord',
// href: 'https://discord.com/channels/897514728459468821/1262501866915237908',
// },
// ],
// },
// {
// title: 'More',
// items: [
// {
// label: 'Blog',
// to: '/blog',
// },
// {
// label: 'GitHub',
// href: 'https://github.com/facebook/docusaurus',
// },
// ],
// },
// ],
copyright: `Copyright © ${new Date().getFullYear()} Tansu. Made by Consulting Manao GmbH.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};

export default config;
Loading

0 comments on commit 4fa70ff

Please sign in to comment.