History

allanaaa 4a4be06b24 Merge branch 'docs-formatting' of https://github.com/allanaaa/OpenRefine into docs-formatting		2021-01-05 12:07:32 -05:00
..
docs	Merge branch 'docs-formatting' of https://github.com/allanaaa/OpenRefine into docs-formatting	2021-01-05 12:07:32 -05:00
src	More	2020-12-16 11:18:00 -05:00
static	Merge branch 'master' into docs-formatting	2021-01-05 12:00:48 -05:00
.gitignore	begin Docusaurus 2 migration (#2799 )	2020-06-29 08:45:24 +02:00
docusaurus.config.js	Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261 )	2020-10-16 20:49:57 +02:00
package.json	Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261 )	2020-10-16 20:49:57 +02:00
README.md	begin Docusaurus 2 migration (#2799 )	2020-06-29 08:45:24 +02:00
sidebars.js	Across-the-docs updates	2020-12-02 13:44:55 -05:00
yarn.lock	Bump ini from 1.3.5 to 1.3.7 in /docs (#3403 )	2020-12-30 09:13:33 +01:00

How to build these docs

We use Docusaurus 2 for our docs, a modern static website generator.

Assuming you have Node.js installed (which includes npm), you can install Docusaurus with:

You will need to install Yarn before you can build the site.

npm install -g yarn

Once you have installed yarn, navigate to docs directory & set-up the dependencies.

cd docs
yarn

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.

yarn build

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

GIT_USER=<Your GitHub username> USE_SSH=true 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.