mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00

History

* update badges

* fix badges

* better badges

* move credits

* more badge work

* add gh logo

* update some copy

* update logo

* fix height

* update text

* emdash

* remove cruft

* move title

* update links

* add hr

* white logo

* move some stuff to getting-started

* revert logo

* more copy changes

* minor tweaks

* fix sidebar

* explicit sidebar

* words

* fix tag

* fix how-to

* more docs work

* update styles

* fix up custom sandbox docs

* change eval title

* fix up getting-started

* fix getting started

* update to 0.9.2

* update screenshot

* add company link

* fix dark mode

* minor fixes

* update image

* update headless and cli docs

* update readme

* fix links

* revert package

* rename links

* fix links

* fix link

* chagne to claude

2024-09-04 21:22:52 +00:00

i18n

docs: delete "ssh_box and image_agnostic_util references" in zh-hans doc (#3647 )

2024-08-29 04:36:35 +00:00

modules

Documentation updates (#3733 )

2024-09-04 21:22:52 +00:00

plugins

Fix: Codebase font fixed, and other fixes for #2138 PR (#2154 )

2024-06-01 02:22:44 +00:00

src

Documentation updates (#3733 )

2024-09-04 21:22:52 +00:00

static

Documentation updates (#3733 )

2024-09-04 21:22:52 +00:00

.gitignore

docs(docs): start implementing docs website (#1372 )

2024-04-29 10:00:51 -07:00

babel.config.js

docs(docs): start implementing docs website (#1372 )

2024-04-29 10:00:51 -07:00

docusaurus.config.ts

Documentation updates (#3733 )

2024-09-04 21:22:52 +00:00

package-lock.json

chore(deps): bump prism-react-renderer from 2.3.1 to 2.4.0 in /docs (#3675 )

2024-08-31 00:10:47 +08:00

package.json

chore(deps): bump prism-react-renderer from 2.3.1 to 2.4.0 in /docs (#3675 )

2024-08-31 00:10:47 +08:00

README.md

docs(docs): start implementing docs website (#1372 )

2024-04-29 10:00:51 -07:00

sidebars.ts

Documentation updates (#3733 )

2024-09-04 21:22:52 +00:00

tsconfig.json

docs(docs): start implementing docs website (#1372 )

2024-04-29 10:00:51 -07:00

README.md

Website

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

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.