diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..ac539d9da --- /dev/null +++ b/docs/README.md @@ -0,0 +1,28 @@ +How to build these docs +======================= + +We use [Docusaurus](https://docusaurus.io/) for our docs. Assuming you have [Node.js](https://nodejs.org/en/download/) installed (which includes npm), you can install Docusaurus with: + +You will need to install [Yarn](https://yarnpkg.com/getting-started/install) before you can build the site. +```sh +npm install -g yarn +``` + +Once you have installed yarn, navigate to docs directory & set-up the dependencies. + +```sh +cd docs +yarn +``` + +Once this is done, generate the docs with: + +```sh +yarn build +``` + +You can also spin a local web server to serve the docs for you, with auto-refresh when you edit the source files, with: +```sh +yarn start +``` + diff --git a/docs/package.json b/docs/package.json index 1f87392a9..24507cd3d 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,4 +1,9 @@ { + "name": "OpenRefine-Documentation", + "version": "1.0.0", + "description": "Documentation for OpenRefine", + "license": "BSD-3-Clause", + "author": "OpenRefine", "scripts": { "examples": "docusaurus-examples", "start": "docusaurus-start", diff --git a/docs/siteConfig.js b/docs/siteConfig.js index fc3bc3082..97e9214f6 100644 --- a/docs/siteConfig.js +++ b/docs/siteConfig.js @@ -4,8 +4,8 @@ const siteConfig = { title: 'OpenRefine', // Title for your website. tagline: 'A power tool for working with messy data.', - url: 'https://openrefine.github.io/', - baseUrl: '/docs-prototype/', + url: 'https://docs.openrefine.org/', + baseUrl: '/', projectName: 'OpenRefine', organizationName: 'OpenRefine',