Skip to content
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ nohup.out
contributors.csv
.claude/
nohup.out
tmp/
tmp/
stackql_mcp_server_*.log
3 changes: 3 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
.docusaurus
.cache-loader

# Shared stackql/docusaurus-config, vendored at build time (yarn vendor-config)
.shared-config/

# Misc
.DS_Store
.env.local
Expand Down
27 changes: 27 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,33 @@ $ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Shared StackQL chrome

The navbar, footer, menus and cross-site redirect routes are shared with
[stackql.io](https://stackql.io) and the provider microsites through
[stackql/docusaurus-config](https://github.com/stackql/docusaurus-config).
It is vendored, not installed: `yarn start` and `yarn build` first run
`yarn vendor-config`, which shallow-clones its `main` branch into the
gitignored `.shared-config/` folder, so `git` and network access are needed
to build. The Providers menu is generated from `https://stackql.io/providers.json`
at build time; set `STACKQL_PROVIDER_CATALOG` to a local copy to build offline.

`docusaurus.config.js` composes the shared building blocks (`buildNavbar`,
`buildFooter`, `sharedPlugin`, `redirectRoutes`) rather than calling
`createConfig`, which is specific to the provider microsites. Site-local pieces:

- the `STACKQL>> | DEPLOY` wordmark (`static/img/stackql-deploy-logo*.svg`),
sized to the same 320x40 box as the registry wordmark on the provider sites
- the sidebar, which opens with the shared "Back to StackQL Docs" link
(`/stackqldocs`, styled by `.sidebar-back-link` in `src/css/global.css`)
- `@stackql/docusaurus-plugin-structured-data` (config under
`themeConfig.structuredData`) and `@stackql/docusaurus-plugin-aeo`
(`.md` companions, `llms.txt`, Ask AI button), the same plugins as stackql.io

Do not add pages under `src/pages` at the shared redirect paths (`/install`,
`/stackqldocs`, `/providers`, `/blog`, `/contact-us`, ...); the shared plugin
registers those routes.

### Deployment

Using SSH:
Expand Down
2 changes: 2 additions & 0 deletions website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ custom_edit_url: null
tags: []
draft: false
unlisted: false
# emits a SoftwareApplication node (structured-data plugin), as on stackql.io
softwareApplication: true
---

![StackQL Deploy](/img/stackql-deploy-featured-image.png)
Expand Down
Loading
Loading