mirror of
https://github.com/microsoft/autogen.git
synced 2026-02-06 14:54:55 -05:00
38d03b0e63
* Initial infrasctructure for notebooks page * migrate two notebooks * add readme notification for notebook dir * override 'text' prism language to add basic syntactical structure to autogens output * Rework to retain existing directory and not expose front matter to consumers of the notebook * improve error handling of process notebooks * format, ruff and type fixes * undo changes to navbar * update readme, CI * whitespace * spelling mistakes * spelling * Add contributing guide for notebooks * update notebook * formatting
42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
|
|
|
|
## Prerequisites
|
|
|
|
To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/), and then installing [Yarn](https://classic.yarnpkg.com/en/).
|
|
On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:
|
|
|
|
```console
|
|
npm install --global yarn
|
|
```
|
|
|
|
## Installation
|
|
|
|
```console
|
|
pip install pydoc-markdown pyyaml colored
|
|
cd website
|
|
yarn install
|
|
```
|
|
|
|
### Install Quarto
|
|
|
|
`quarto` is used to render notebooks.
|
|
|
|
Install it [here](https://quarto.org/docs/get-started/).
|
|
|
|
> Note: Support for Docusaurus 3.0 in Quarto is from version `1.4`. Ensure that your `quarto` version is `1.4` or higher.
|
|
|
|
## Local Development
|
|
|
|
Navigate to the `website` folder and run:
|
|
|
|
```console
|
|
pydoc-markdown
|
|
quarto render ./docs
|
|
python ./process_notebooks.py
|
|
yarn start
|
|
```
|
|
|
|
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|