-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
249 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- js/apps/docs/** | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
working-directory: js | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: 20 | ||
cache: npm | ||
cache-dependency-path: js/package-lock.json | ||
- run: npm ci -w @canary/docs | ||
- run: npm run build -w @canary/docs | ||
- name: Deploy | ||
uses: cloudflare/wrangler-action@v3 | ||
with: | ||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | ||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | ||
command: pages deploy apps/docs/dist --project-name=canary-docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# build output | ||
dist/ | ||
# generated types | ||
.astro/ | ||
|
||
# dependencies | ||
node_modules/ | ||
|
||
# logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
|
||
|
||
# environment variables | ||
.env | ||
.env.production | ||
|
||
# macOS-specific files | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# @canary/docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
import { defineConfig } from "astro/config"; | ||
import starlight from "@astrojs/starlight"; | ||
|
||
// https://astro.build/config | ||
export default defineConfig({ | ||
redirects: { | ||
"/": "/intro/readme/", | ||
}, | ||
integrations: [ | ||
starlight({ | ||
title: "🐤 Canary", | ||
social: { | ||
github: "https://github.com/fastrepl/canary", | ||
}, | ||
editLink: { | ||
baseUrl: "https://github.com/fastrepl/canary/js/apps/docs", | ||
}, | ||
sidebar: [ | ||
{ | ||
label: "Start Here", | ||
items: [ | ||
{ label: "README", link: "/intro/readme/" }, | ||
{ label: "Self-host", link: "/intro/self-host/" }, | ||
{ label: "Cloud", link: "/intro/cloud/" }, | ||
], | ||
}, | ||
{ | ||
label: "Sources", | ||
items: [ | ||
{ label: "Overview", link: "/sources/overview/" }, | ||
{ label: "Website", link: "/sources/website/" }, | ||
{ label: "Github", link: "/sources/github/" }, | ||
], | ||
}, | ||
{ | ||
label: "Clients", | ||
items: [ | ||
{ label: "Overview", link: "/clients/overview/" }, | ||
{ label: "Website", link: "/clients/website/" }, | ||
{ label: "Discord", link: "/clients/discord/" }, | ||
], | ||
}, | ||
{ | ||
label: "Packages", | ||
collapsed: true, | ||
autogenerate: { directory: "packages" }, | ||
}, | ||
{ | ||
label: "Miscellaneous", | ||
collapsed: true, | ||
autogenerate: { directory: "others" }, | ||
}, | ||
], | ||
customCss: ["./src/styles/theme.css"], | ||
}), | ||
], | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
"name": "@canary/docs", | ||
"type": "module", | ||
"private": true, | ||
"scripts": { | ||
"dev": "astro dev", | ||
"start": "astro dev", | ||
"build": "astro check && astro build", | ||
"preview": "astro preview", | ||
"astro": "astro" | ||
}, | ||
"dependencies": { | ||
"@astrojs/check": "^0.7.0", | ||
"@astrojs/starlight": "^0.24.2", | ||
"astro": "^4.10.2", | ||
"sharp": "^0.32.5", | ||
"typescript": "^5.4.5" | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import { defineCollection } from "astro:content"; | ||
import { docsSchema } from "@astrojs/starlight/schema"; | ||
|
||
export const collections = { | ||
docs: defineCollection({ schema: docsSchema() }), | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Discord | ||
--- | ||
|
||
If valid `DISCORD_BOT_TOKEN` is provided as an environment variable, Discord client will be enabled. | ||
|
||
Endpoint url is `<BASE_URL>/api/discord`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: What is Client? | ||
--- | ||
|
||
`Client` is a way to let users interact with `Canary`. | ||
|
||
Currently, we support two clients: | ||
|
||
- [Website](/clients/website/) | ||
- [Discord](/clients/discord/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Website | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Cloud | ||
--- | ||
|
||
Not available yet. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: What is Canary? | ||
--- | ||
|
||
**`Canary`** provides you all the tools to provide **`Ask AI`** to your users, especially developers. | ||
|
||
This includes: | ||
|
||
- wq | ||
- qwd | ||
- qwdq | ||
- qwdq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Self-host | ||
--- | ||
|
||
We have a [![Railway Template](https://railway.app/button.svg)](https://railway.app/template/mn9WJT?referralCode=IQ76H8) that you can use to deply your own instance of `Canary`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: AI | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "@canary/core" | ||
--- | ||
|
||
https://github.com/fastrepl/canary/tree/main/js/packages/core |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "@canary/docusaurus" | ||
--- | ||
|
||
This is intended to be a drop-in replacement for `docusaurus-lunr-search`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "@canary/starlight" | ||
--- | ||
|
||
This is intended to be a drop-in replacement for built-in search-bar. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "@canary/web-widget" | ||
--- | ||
|
||
This is a [Web Component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) that can be used in any website to add a modal. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Github | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: What is Source? | ||
--- | ||
|
||
`Source` is a way to provide information to `Canary`. | ||
|
||
Currently, we support two sources: | ||
|
||
- [Website](/sources/website/) | ||
- [Github](/sources/github/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Website | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/// <reference path="../.astro/types.d.ts" /> | ||
/// <reference types="astro/client" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/* Dark mode colors. */ | ||
:root { | ||
--sl-color-accent-low: #312000; | ||
--sl-color-accent: #8a6100; | ||
--sl-color-accent-high: #e8c384; | ||
--sl-color-white: #ffffff; | ||
--sl-color-gray-1: #eeeeee; | ||
--sl-color-gray-2: #c2c2c2; | ||
--sl-color-gray-3: #8b8b8b; | ||
--sl-color-gray-4: #585858; | ||
--sl-color-gray-5: #383838; | ||
--sl-color-gray-6: #272727; | ||
--sl-color-black: #181818; | ||
} | ||
|
||
/* Light mode colors. */ | ||
:root[data-theme="light"] { | ||
--sl-color-accent-low: #efd3a5; | ||
--sl-color-accent: #8c6300; | ||
--sl-color-accent-high: #442e00; | ||
--sl-color-white: #181818; | ||
--sl-color-gray-1: #272727; | ||
--sl-color-gray-2: #383838; | ||
--sl-color-gray-3: #585858; | ||
--sl-color-gray-4: #8b8b8b; | ||
--sl-color-gray-5: #c2c2c2; | ||
--sl-color-gray-6: #eeeeee; | ||
--sl-color-gray-7: #f6f6f6; | ||
--sl-color-black: #ffffff; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"extends": "astro/tsconfigs/strict" | ||
} |