Skip to content

Commit 82c8ac9

Browse files
committed
Init project
1 parent f111c0a commit 82c8ac9

34 files changed

+5370
-2
lines changed

.docker/Dockerfile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Clone the project
2+
FROM alpine/git as git
3+
4+
ARG REPOSITORY=https://github.com/buggregator/docs
5+
ARG BRANCH=master
6+
RUN git clone -b $BRANCH $REPOSITORY /app
7+
8+
FROM node:19 as node
9+
10+
COPY --from=git /app /app
11+
WORKDIR /app
12+
13+
RUN npm add -D vitepress
14+
RUN npm i
15+
RUN npm run docs:build
16+
17+
FROM nginx:alpine as server
18+
19+
COPY --from=node /app/docs/.vitepress/dist /usr/share/nginx/html

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
patreon: butschster

.github/workflows/docker-image.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Docker Image CI
2+
3+
on:
4+
release:
5+
types:
6+
- created
7+
8+
jobs:
9+
build-release:
10+
if: "!github.event.release.prerelease"
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
- name: 'Get Previous tag'
17+
id: previoustag
18+
uses: "WyriHaximus/github-action-get-previous-tag@v1"
19+
with:
20+
fallback: v0.1
21+
22+
- name: Login to Docker Hub
23+
uses: docker/login-action@v2
24+
with:
25+
registry: ghcr.io
26+
username: ${{ secrets.GHCR_LOGIN }}
27+
password: ${{ secrets.GHCR_PASSWORD }}
28+
29+
- name: Set up QEMU
30+
uses: docker/setup-qemu-action@v2
31+
32+
- name: Set up Docker Buildx
33+
id: buildx
34+
uses: docker/setup-buildx-action@v2
35+
36+
- name: Build and push
37+
id: docker_build
38+
uses: docker/build-push-action@v3
39+
with:
40+
context: ./
41+
platforms: linux/amd64,linux/arm64
42+
file: ./.docker/Dockerfile
43+
push: true
44+
build-args: |
45+
APP_VERSION=${{ steps.previoustag.outputs.tag }}
46+
FRONTEND_IMAGE_TAG=latest
47+
tags:
48+
ghcr.io/${{ github.repository }}:latest, ghcr.io/${{ github.repository }}:${{ steps.previoustag.outputs.tag }}

.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+
/docs/.vitepress/cache
4+
/docs/.vitepress/dist

README.md

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

docs/.vitepress/config.mts

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import {defineConfig} from 'vitepress'
2+
3+
export default defineConfig({
4+
ignoreDeadLinks: true,
5+
title: "Context Generator Docs",
6+
description: "Documentation for Context Generator for LLM",
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
search: {
10+
provider: 'local'
11+
},
12+
13+
nav: [
14+
{text: 'Docs', link: '/'},
15+
{text: 'GitHub', link: 'https://github.com/butschster/context-generator'},
16+
{text: 'Json Schema', link: 'https://raw.githubusercontent.com/butschster/context-generator/refs/heads/main/json-schema.json'}
17+
],
18+
19+
sidebar: [
20+
{
21+
text: 'Home',
22+
link: '/'
23+
},
24+
{
25+
text: 'Getting Started',
26+
items: [
27+
{text: 'Installation', link: '/getting-started'},
28+
{text: 'Configuration', link: '/configuration'},
29+
{text: 'Command Reference', link: '/getting-started/command-reference'},
30+
{text: 'Environment Variables', link: '/environment-variables'},
31+
{text: 'IDE Integration', link: '/getting-started/ide-integration'},
32+
{text: 'Logging', link: '/advanced/logging'}
33+
]
34+
},
35+
{
36+
text: 'Config Reference',
37+
items: [
38+
{text: 'Document Structure', link: '/documents'},
39+
{text: 'File Source', link: '/sources/file-source'},
40+
{text: 'GitHub Source', link: '/sources/github-source'},
41+
{text: 'Git Diff Source', link: '/sources/git-diff-source'},
42+
{text: 'URL Source', link: '/sources/url-source'},
43+
{text: 'Text Source', link: '/sources/text-source'},
44+
{text: 'Composer Source', link: '/sources/composer-source'},
45+
{text: 'Tree Source', link: '/sources/tree-source'}
46+
]
47+
},
48+
{
49+
text: 'Modifiers',
50+
items: [
51+
{text: 'What is a Modifier?', link: '/modifiers'},
52+
{text: 'PHP Signature Modifier', link: '/modifiers/php-signature'},
53+
{text: 'PHP Content Filter Modifier', link: '/modifiers/php-content-filter'},
54+
{text: 'Sanitizer Modifier', link: '/modifiers/sanitizer'},
55+
{text: 'PHP-Docs Modifier', link: '/modifiers/php-docs'},
56+
{text: 'Document-Level Modifiers', link: '/modifiers/document-level'},
57+
{text: 'Modifier Aliases', link: '/modifiers/aliases'}
58+
]
59+
},
60+
{
61+
text: 'Advanced',
62+
items: [
63+
{text: 'Development with Context Generator', link: '/advanced/development-process'},
64+
],
65+
},
66+
{
67+
text: 'Contributing',
68+
link: '/contributing',
69+
}
70+
],
71+
72+
socialLinks: [
73+
{icon: 'github', link: 'https://github.com/butschster/context-generator'}
74+
]
75+
}
76+
})

docs/.vitepress/theme/index.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
3+
export default {
4+
extends: DefaultTheme,
5+
enhanceApp({ app }) {
6+
7+
}
8+
}

0 commit comments

Comments
 (0)