mirror of https://github.com/microsoft/autogen.git synced 2025-08-07 00:02:29 +00:00

History

update readme to add note on required Quarto Version. Update readme t… (#1493 )

* update readme to add note on required Quarto Version. Update readme to mention docusaurus 3.0 support

* Update website/README.md

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>

---------

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>

2024-01-31 22:11:47 +00:00

blog

Fixed broken links. (#1408 )

2024-01-26 01:54:51 +00:00

docs

Function calling upgrade (#1443 )

2024-01-31 15:30:55 +00:00

src

Improve docs/gallery card component (#1445 )

2024-01-29 22:49:06 +00:00

static

add new gallery item (#1365 )

2024-01-24 01:18:00 +00:00

.gitignore

docs: initial Jupyter support for website docs, move config notebook (#1448 )

2024-01-30 22:54:44 +00:00

babel.config.js

web-template

2023-08-27 21:30:54 -04:00

docusaurus.config.js

fix website production css (#1366 )

2024-01-23 00:50:59 +00:00

package.json

fix website production css (#1366 )

2024-01-23 00:50:59 +00:00

pydoc-markdown.yml

Upgrade docusaurus (#1101 )

2024-01-13 14:54:37 +00:00

README.md

update readme to add note on required Quarto Version. Update readme t… (#1493 )

2024-01-31 22:11:47 +00:00

sidebars.js

docs: initial Jupyter support for website docs, move config notebook (#1448 )

2024-01-30 22:54:44 +00:00

yarn.lock

fix website production css (#1366 )

2024-01-23 00:50:59 +00:00

README.md

Website

This website is built using Docusaurus 3, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown
cd website
yarn install

Install Quarto

quarto is used to render notebooks.

Install it here.

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:

pydoc-markdown
quarto render ./docs
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.