https://github.com/openrefine/openrefine.org
Source website for openrefine.org
https://github.com/openrefine/openrefine.org
Last synced: 3 months ago
JSON representation
Source website for openrefine.org
- Host: GitHub
- URL: https://github.com/openrefine/openrefine.org
- Owner: OpenRefine
- License: other
- Created: 2012-10-24T18:33:47.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T07:39:57.000Z (8 months ago)
- Last Synced: 2024-10-25T02:54:34.348Z (8 months ago)
- Language: TypeScript
- Homepage: https://openrefine.org
- Size: 32.1 MB
- Stars: 134
- Watchers: 35
- Forks: 118
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
OpenRefine.org website
======================
We use [Docusaurus](https://docusaurus.io/) for our website.
If you want to run it locally, you can follow the instructions below, otherwise you should be able to edit most pages directly with a Markdown editor or IDE.
Opening a pull request for your changes will generate a preview on Netlify that you can browse to check the rendering.
### Requirements
Building the website requires [Node.js (LTS recommended)](https://nodejs.org/en/download/), which includes the `npm` package manager.
### Installation
Once you have installed Node, which includes the npm package manager, we can install and set-up the dependencies:
```sh
npm install
```
### Local Development
The following command starts a local development server and opens up a browser window. Usually at the URL .
Most changes you make to pages and content are reflected live without having to restart the server.
```sh
npm run start
```
### Build
The following command generates static content into the `build` directory and can be served using any static contents hosting service.
```sh
npm run build
```
### (Optional) Test Build Locally
You can locally test ([with parameters](https://docusaurus.io/docs/cli#docusaurus-serve-sitedir)) the static content in the `build` directory (in case you don't have access to a hosting service) by using:
```sh
npm run serve
```
### Deployment
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.
```sh
GIT_USER= USE_SSH=true npm run deploy
```
### License
This website is published under the [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).