Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emiliorighi committed Nov 29, 2024
1 parent 8bdb615 commit 8addd52
Show file tree
Hide file tree
Showing 55 changed files with 128,345 additions and 255 deletions.
60 changes: 60 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [docs]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci # or pnpm install / yarn install / bun install
- name: Build with VitePress
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ venv
.env
__pycache__
blog_old.md
bgp-docs/.vitepress/dist
bgp-docs/.vitepress/cache
node_modules
56 changes: 0 additions & 56 deletions deploy_example/docker-compose-example.yml

This file was deleted.

41 changes: 0 additions & 41 deletions deploy_example/example.env

This file was deleted.

Binary file removed dist/favicon-16x16.png
Binary file not shown.
Binary file removed dist/favicon-32x32.png
Binary file not shown.
16 changes: 0 additions & 16 deletions dist/index.css

This file was deleted.

79 changes: 0 additions & 79 deletions dist/oauth2-redirect.html

This file was deleted.

20 changes: 0 additions & 20 deletions dist/swagger-initializer.js

This file was deleted.

3 changes: 0 additions & 3 deletions dist/swagger-ui-bundle.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui-bundle.js.map

This file was deleted.

3 changes: 0 additions & 3 deletions dist/swagger-ui-es-bundle-core.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui-es-bundle-core.js.map

This file was deleted.

3 changes: 0 additions & 3 deletions dist/swagger-ui-es-bundle.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui-es-bundle.js.map

This file was deleted.

3 changes: 0 additions & 3 deletions dist/swagger-ui-standalone-preset.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui-standalone-preset.js.map

This file was deleted.

3 changes: 0 additions & 3 deletions dist/swagger-ui.css

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui.css.map

This file was deleted.

2 changes: 0 additions & 2 deletions dist/swagger-ui.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/swagger-ui.js.map

This file was deleted.

Loading

0 comments on commit 8addd52

Please sign in to comment.