Skip to content

Commit

Permalink
Merge pull request #14 from harishmohanraj/delete-docusaurus-files
Browse files Browse the repository at this point in the history
Delete docusaurus files
  • Loading branch information
harishmohanraj authored Dec 18, 2024
2 parents b0fa589 + a1acb3f commit 7634338
Show file tree
Hide file tree
Showing 25 changed files with 3,158 additions and 9,576 deletions.
9 changes: 2 additions & 7 deletions .github/workflows/deploy-website-mintlify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,9 @@ jobs:
- name: Install quarto
uses: quarto-dev/quarto-actions/setup@v2

- name: Generate API documentation
- name: Build website
run: |
python ./process_api_reference.py
working-directory: website

- name: Convert Jupyter notebooks to MDX
run: |
python ./process_notebooks.py render
./build_website.sh
working-directory: website

- name: Prepare website content
Expand Down
19 changes: 10 additions & 9 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# Website

This website is built using [Mintlify](https://mintlify.com/docs/quickstart), a modern website generator.
This website is powered by [Mintlify](https://mintlify.com/docs/quickstart), a modern and user-friendly website generator.

## Prerequisites

To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/) and [Mintlify CLI](https://www.npmjs.com/package/mintlify)
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
Expand All @@ -24,16 +31,10 @@ Install it [here](https://github.com/quarto-dev/quarto-cli/releases).

Navigate to the `website` folder and run:

```console
pydoc-markdown
python ./process_notebooks.py render
npm install
```

Run the following command at the root of your documentation (where mint.json is)

```console
npm run mintlify:dev
./serve_website.sh
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
3 changes: 0 additions & 3 deletions website/babel.config.js

This file was deleted.

5 changes: 1 addition & 4 deletions website/build_website.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@ then
fi

# Generate documentation using pydoc-markdown
pydoc-markdown
python ./process_api_reference.py

# Process notebooks using a Python script
python ./process_notebooks.py render

# Start the website using yarn
yarn start
313 changes: 0 additions & 313 deletions website/docusaurus.config.js

This file was deleted.

7 changes: 7 additions & 0 deletions website/serve_website.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

# Import the build script
source "./build_website.sh"

# Start the website
npm run mintlify:dev
Loading

0 comments on commit 7634338

Please sign in to comment.