mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
3a8a71dd15
* This change creates a PR * start moving stuff around * data_models/_category_.json * reference/_category_.json * moving some stuff around * Introduction * Documentation updates * few broken links, clean up sidebar titles for how-to * codespell * quickstart - new provider extension * add a comment * map provider interface * quickstart for new router extension * [Docs] diataxis refactor refactor (#6425) * Start refactor * Edits * [DOCS] Reorganize and edit. Fix sidebar navigation (#6445) * Reorganize and edit. Fix sidebar navigation * Fix broken linkages * Edit --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix links --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Fix broken links * Reword CLA part in the Licensing FAQ * change titles and order suggestion - cc @IgorWounds @piiq --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
65 lines
1.6 KiB
Plaintext
Vendored
65 lines
1.6 KiB
Plaintext
Vendored
---
|
|
title: Documentation - Development
|
|
sidebar_position: 30
|
|
description: Building the OpenBB Platform documentation and packages.
|
|
keywords:
|
|
- OpenBB Platform
|
|
- Open source
|
|
- Documentation
|
|
- Development
|
|
- Markdown
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="Documentation - Development | OpenBB Platform Docs" />
|
|
|
|
|
|
The documentation and packages are kept in the `/website` folder, at the base of the repository. Navigate there to install the dependencies and start the development server.
|
|
|
|
### Generate Markdown Files
|
|
|
|
Markdown files for the Reference and Data Models pages need to be generated.
|
|
This will generate content based on what is actually installed and contained locally, so it may appear different than what is on this website.
|
|
|
|
Open a terminal command line to the `/OpenBBTerminal/website` folder, then enter:
|
|
|
|
```bash
|
|
python generate_platform_v4_markdown.py
|
|
```
|
|
|
|
### Node.js
|
|
|
|
- [Node.js](https://nodejs.org/en/) >= 16.13.0
|
|
To check if Node.js installed, run this command:
|
|
|
|
```bash
|
|
node --version # should be v16.13.0 or higher
|
|
```
|
|
|
|
#### Install Dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
#### Start Development Server
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
This starts a local development server at: [http://localhost:3000](http://localhost:3000)
|
|
|
|
Most changes are reflected live without having to restart the server.
|
|
|
|
#### Build
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
OpenBB uses Github Pages to host our website, it's deployed in the `gh-pages` branch.
|