Files
FLAML/website
Noël Barron 0fe284b21f Doc and comment typos improvements (#1319)
* typographical corrections in the descriptions, comment improvements, general formatting for consistency

* consistent indentation for better readability, improved comments, typographical corrections

* updated docstrings for better clarity, added type hint for **kwargs, typographical corrections (no functionality changes)

* Fix format

---------

Co-authored-by: Li Jiang <bnujli@gmail.com>
2024-08-06 15:29:37 +00:00
..
2023-09-23 16:55:30 +00:00
2021-12-16 17:11:33 -08:00
2021-12-16 17:11:33 -08:00

Website

This website is built using Docusaurus 2, 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

Local Development

Navigate to the website folder and run:

pydoc-markdown
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.