-
Notifications
You must be signed in to change notification settings - Fork 57
Migrate docs from mdbook to docusaurus #692
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
c13e96e
8e19566
f018cfe
f3cad5c
08df0ed
0ac2eee
fcc8d18
f36cb3e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: Trigger Aggregator Docs Rebuild | ||
|
|
||
| on: | ||
| push: | ||
| branches: [next] | ||
|
|
||
| jobs: | ||
| notify: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| steps: | ||
| - name: Send repository_dispatch to aggregator | ||
| uses: peter-evans/repository-dispatch@v3 | ||
|
||
| with: | ||
| # PAT (Personal Access Token) that grants permission to trigger the rebuild workflow at the docs repository | ||
| token: ${{ secrets.DOCS_REPO_TOKEN }} | ||
| repository: ${{ vars.DOCS_AGGREGATOR_REPO }} | ||
| event-type: rebuild | ||
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| .docusaurus/ | ||
| build/ | ||
| node_modules/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import type { Config } from "@docusaurus/types"; | ||
|
|
||
| // If your content lives in docs/src, set DOCS_PATH='src'; else '.' | ||
| const DOCS_PATH = | ||
| process.env.DOCS_PATH || (require("fs").existsSync("src") ? "src" : "."); | ||
|
|
||
| const config: Config = { | ||
| title: "Docs Dev Preview", | ||
| url: "http://localhost:3000", | ||
| baseUrl: "/", | ||
| trailingSlash: false, | ||
|
|
||
| // Minimal classic preset: docs only, autogenerated sidebars, same math plugins as prod | ||
| presets: [ | ||
| [ | ||
| "classic", | ||
| { | ||
| docs: { | ||
| path: DOCS_PATH, // '../docs' is implied because we are already inside docs/ | ||
| routeBasePath: "/", // mount docs at root for quick preview | ||
| sidebarPath: "./sidebars.ts", | ||
| remarkPlugins: [require("remark-math")], | ||
| rehypePlugins: [require("rehype-katex")], | ||
| }, | ||
| blog: false, | ||
| pages: false, | ||
| }, | ||
| ], | ||
| ], | ||
| }; | ||
| export default config; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably want to only trigger this workflow if files in the
docsdirectory change, no?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely agreed, will fix!