Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs to Nextra #654

Merged
merged 11 commits into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Docs Docker Image

on:
push:
branches:
- "main"

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Login to GitHub Container Registry
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build and push
uses: docker/build-push-action@v4
with:
context: ./docs
platforms: linux/amd64
push: true
tags: ghcr.io/txpipe/oura-docs:${{ github.sha }}
23 changes: 0 additions & 23 deletions .github/workflows/mdbook.yml

This file was deleted.

1 change: 0 additions & 1 deletion book/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions book/book.toml

This file was deleted.

44 changes: 0 additions & 44 deletions book/src/SUMMARY.md

This file was deleted.

11 changes: 0 additions & 11 deletions book/src/advanced/README.md

This file was deleted.

1 change: 0 additions & 1 deletion book/src/guides/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions book/src/installation/README.md

This file was deleted.

1 change: 0 additions & 1 deletion book/src/reference/README.md

This file was deleted.

20 changes: 0 additions & 20 deletions book/src/sinks/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions book/src/usage/README.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
.next
8 changes: 8 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
FROM node:18-alpine
WORKDIR /usr/app
COPY package*.json ./
RUN npm install
COPY . ./
RUN npm run build
EXPOSE 8080
CMD ["npm", "start"]
31 changes: 31 additions & 0 deletions docs/components/hero.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
export function Hero() {
return (
<div className="py-10 md:p-20">
<div className="mb-5 text-center">
<h1 className="flex flex-col flex-wrap font-bold text-4xl md:text-6xl lg:text-7xl dark:text-gray-200">
<img src="/logo.svg" alt="Oura" className="mb-4" />
The tail of Cardano
</h1>
</div>

<div className="mb-8 max-w-3xl text-center mx-auto">
<p className="md:text-lg text-gray-600 dark:text-gray-400">
Oura is a rust-native implementation of a pipeline that connects to
the tip of a Cardano node through a combination of Ouroboros
mini-protocol (using either a unix socket or tcp bearer), filters the
events that match a particular pattern and then submits a succinct,
self-contained payload to pluggable observers called "sinks".
</p>
</div>

<div className="flex justify-center">
<a
className="bg-gradient-to-tl from-emerald-600 to-cyan-600 border border-transparent text-white text-sm rounded-md focus:outline-none focus:ring-2 focus:ring-blue-600 focus:ring-offset-2 focus:ring-offset-white py-3 px-4 dark:focus:ring-offset-gray-800"
href="/v2"
>
Documentation
</a>
</div>
</div>
);
}
6 changes: 6 additions & 0 deletions docs/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
const withNextra = require("nextra")({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.jsx",
});

module.exports = withNextra();
Loading