History

Eric Zhu 297904f210 Add link to PromptFlow Sample App (#2418 ) * Update promptflow.md * Update promptflow.md		2024-04-17 16:53:19 +00:00
..
blog	support llm_config in AgentOptimizer (#2299 )	2024-04-11 13:46:42 +00:00
docs	Add link to PromptFlow Sample App (#2418 )	2024-04-17 16:53:19 +00:00
src	DOCS: Add AutoTX to gallery (#2390 )	2024-04-16 19:16:26 +00:00
static	DOCS: Add AutoTX to gallery (#2390 )	2024-04-16 19:16:26 +00:00
.gitignore	Native tool call support for Mistral AI API and topic notebook. (#2135 )	2024-03-25 14:35:29 +00:00
README.md	add RAG under topics (#1990 )	2024-03-14 00:49:39 +00:00
babel.config.js	web-template	2023-08-27 21:30:54 -04:00
build_website.sh	Extend process_notebooks for testing (#1789 )	2024-02-29 20:47:30 +00:00
docusaurus.config.js	Auto collapse side bar entries when selecting other sections (#2257 )	2024-04-02 23:13:18 +00:00
package.json	add clarity analytics (#2201 )	2024-03-28 23:26:22 +00:00
process_notebooks.py	Add isort (#2265 )	2024-04-05 02:26:06 +00:00
pydoc-markdown.yml	fix some docstring issues affecting rendering (#1739 )	2024-02-20 22:29:39 +00:00
sidebars.js	Break up contributor guide for better navigability (#2250 )	2024-04-02 14:51:22 +00:00
yarn.lock	add clarity analytics (#2201 )	2024-03-28 23:26:22 +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 pyyaml colored
cd website
yarn install

Install Quarto

quarto is used to render notebooks.

Install it here.

Note: Ensure that your quarto version is 1.5.23 or higher.

Local Development

Navigate to the website folder and run:

pydoc-markdown
python ./process_notebooks.py render
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.