Skip to content

Commit

Permalink
update docs (#48)
Browse files Browse the repository at this point in the history
* new logo

* update theme

* use tailwind

* use geist font

* fixie fix
  • Loading branch information
amalshaji committed Apr 27, 2024
1 parent cfca851 commit 9296b7f
Show file tree
Hide file tree
Showing 13 changed files with 456 additions and 108 deletions.
24 changes: 3 additions & 21 deletions admin/src/portr_admin/static/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 2 additions & 15 deletions admin/src/portr_admin/static/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion admin/src/web/public/vite.svg

This file was deleted.

42 changes: 34 additions & 8 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

import tailwind from "@astrojs/tailwind";

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: "Portr",
customCss: ["./src/styles/custom.css"],
customCss: [
"./src/tailwind.css",
"@fontsource/geist-sans/400.css",
"@fontsource/geist-mono/400.css",
],
social: {
github: "https://github.com/amalshaji/portr",
},
Expand All @@ -21,12 +27,17 @@ export default defineConfig({
{
label: "Guides",
items: [
// Each item here is one entry in the navigation menu.
{ label: "Overview", link: "/getting-started/" },
{
label: "Overview",
link: "/getting-started/",
},
{
label: "Server",
items: [
{ label: "Quickstart", link: "/server/" },
{
label: "Quickstart",
link: "/server/",
},
{
label: "Cloudflare API token",
link: "/server/cloudflare-api-token/",
Expand All @@ -44,9 +55,18 @@ export default defineConfig({
{
label: "Client",
items: [
{ label: "Installation", link: "/client/installation/" },
{ label: "HTTP tunnel", link: "/client/http-tunnel/" },
{ label: "TCP tunnel", link: "/client/tcp-tunnel/" },
{
label: "Installation",
link: "/client/installation/",
},
{
label: "HTTP tunnel",
link: "/client/http-tunnel/",
},
{
label: "TCP tunnel",
link: "/client/tcp-tunnel/",
},
{
label: "Websocket tunnel",
link: "/client/websocket-tunnel/",
Expand All @@ -56,7 +76,10 @@ export default defineConfig({
{
label: "Local development",
items: [
{ label: "Admin", link: "/local-development/admin/" },
{
label: "Admin",
link: "/local-development/admin/",
},
{
label: "Tunnel server",
link: "/local-development/tunnel-server/",
Expand All @@ -71,5 +94,8 @@ export default defineConfig({
},
],
}),
tailwind({
applyBaseStyles: false,
}),
],
});
5 changes: 5 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@
"dependencies": {
"@astrojs/check": "^0.5.10",
"@astrojs/starlight": "^0.21.5",
"@astrojs/starlight-tailwind": "^2.0.2",
"@astrojs/tailwind": "^5.1.0",
"@fontsource/geist-mono": "^5.0.3",
"@fontsource/geist-sans": "^5.0.3",
"astro": "^4.6.0",
"astro-embed": "^0.6.2",
"sharp": "^0.32.6",
"tailwindcss": "^3.4.3",
"typescript": "^5.4.5"
}
}
Loading

0 comments on commit 9296b7f

Please sign in to comment.