Skip to content

Commit

Permalink
[Docs] Upgrade to Docusaurus 3 (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffxy authored Mar 9, 2024
1 parent f54276f commit 4cb8073
Show file tree
Hide file tree
Showing 8 changed files with 9,394 additions and 15,672 deletions.
6 changes: 3 additions & 3 deletions website/docs/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Conductor's caching semantics). You can specify a commit using a hash, branch,
or tag. The specified commit must be an ancestor of the current commit.
This flag cannot be used with `--again` (the two flags are not compatible). This
flag also cannot be used if (i) Conductor's Git integration [is
disabled](configuration.md), (ii) your project is not managed by Git, or (iii)
if your repository is bare (there are no commits).
flag also cannot be used if (i) Conductor's Git integration [is disabled](/docs/configuration.md),
(ii) your project is not managed by Git, or (iii) if your repository is bare
(there are no commits).
How does this flag differ from `--again`? When you set `--again`, Conductor will
always re-run all the relevant tasks, regardless of the cache. With
Expand Down
5 changes: 2 additions & 3 deletions website/docs/cli/where.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ $ cond where [-h] [-p] [-f] task_identifier
This command prints the path to where the specified task's outputs are stored.

If the task is versioned (i.e., it is an experiment task), this command will
print the output path associated with the [most relevant
version](task-types/run-experiment.md#versioning-and-caching-semantics). If no
relevant version exists, this command will return an error.
print the output path associated with the [most relevant version](task-types/run-experiment.md#versioning-and-caching-semantics).
If no relevant version exists, this command will return an error.

Sometimes, no output path will exist. This could be because the task was never
executed, or because the task never produces outputs (e.g.,
Expand Down
3 changes: 1 addition & 2 deletions website/docs/task-types/run-experiment-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ ExperimentInstance(name, args=[], options={}, parallelizable=False)
```

The arguments that `ExperimentInstance()` takes have the same semantics as the
arguments listed in the [`run_experiment()`
reference](task-types/run-experiment.md).
arguments listed in the [`run_experiment()` reference](task-types/run-experiment.md).

:::note

Expand Down
2 changes: 1 addition & 1 deletion website/docs/task-types/run-experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ run_experiment(name, run, parallelizable=False, args=[], options={}, deps=[])
```

A `run_experiment()` task runs the command specified in the `run` argument. The
task's output files are [versioned](#versioning-semantics) and
task's output files are [versioned](#versioning-and-caching-semantics) and
[archivable](cli/archive.md).

All files that this task produces should be written to the path given in the
Expand Down
8 changes: 4 additions & 4 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module.exports = {
title: 'Conductor',
tagline: 'A simple and elegant research computing orchestrator.',
url: 'https://www.geoffreyyu.com/conductor/',
url: 'https://www.geoffreyyu.com/',
baseUrl: '/conductor/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
Expand Down Expand Up @@ -31,9 +31,9 @@ module.exports = {
copyright: `Copyright © ${new Date().getFullYear()} Geoffrey Yu.`,
},
prism: {
theme: require('prism-react-renderer/themes/github'),
darkTheme: require('prism-react-renderer/themes/palenight'),
additionalLanguages: ['toml'],
theme: require('prism-react-renderer').themes.github,
darkTheme: require('prism-react-renderer').themes.palenight,
additionalLanguages: ['toml', 'bash'],
},
},
presets: [
Expand Down
25,018 changes: 9,371 additions & 15,647 deletions website/package-lock.json

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^2.0.0-beta.14",
"@docusaurus/preset-classic": "^2.0.0-beta.14",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.1.1",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"react": "^18.2.0",
"react-dom": "^18.2.0",
"prism-react-renderer": "^2.3.1"
},
"browserslist": {
"production": [
Expand Down
13 changes: 6 additions & 7 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@
--ifm-code-font-size: 95%;
}

.docusaurus-highlight-code-line {
background-color: rgba(0,0,0,.1);
display: block;
margin: 0 calc(-1 * var(--ifm-pre-padding));
padding: 0 var(--ifm-pre-padding);
:root {
--docusaurus-highlighted-code-line-bg: rgba(0,0,0,.1);
}

html[data-theme='dark'] .docusaurus-highlight-code-line {
background-color: rgb(72, 77, 91);
/* If you have a different syntax highlighting theme for dark mode. */
[data-theme='dark'] {
/* Color which works with dark mode syntax highlighting theme */
--docusaurus-highlighted-code-line-bg: rgb(72, 77, 91);
}

0 comments on commit 4cb8073

Please sign in to comment.