Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,27 @@ Opening a pull request for your changes will generate a preview on Netlify that

### Requirements

Building the website requires [Node.js (LTS recommended)](https://nodejs.org/en/download/), which includes the `npm` package manager.
- [Node.js (LTS recommended)](https://nodejs.org/en/download/)

### Installation

Once you have installed Node, which includes the npm package manager, we can install and set-up the dependencies:
CD into the repository parent folder and install dependencies

```sh
cd openrefine.org
npm install
```

### Local Development

The following command starts a local development server and opens up a browser window. Usually at the URL <http://localhost:3000>.

Most changes you make to pages and content are reflected live without having to restart the server.
Start the development server on localhost

```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
```
This command starts a local development server and opens up a browser window. Usually at the URL <http://localhost:3000>
Most changes are reflected live without having to restart the server.

### (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:
Expand Down
6 changes: 4 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ export default async function createConfigAsync() {
return {
markdown: {
mermaid: true,
hooks: {
onBrokenMarkdownLinks: 'throw',
},
},
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
onBrokenAnchors: 'warn',
title: 'OpenRefine',
tagline: 'A power tool for working with messy data.',
Expand Down Expand Up @@ -224,7 +226,7 @@ return {
blog: {
blogSidebarCount: 'ALL',
onInlineAuthors: 'ignore',

onUntruncatedBlogPosts: 'ignore'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are only warnings and seem like a useful nudge to the blog post writers to remember to include the truncation markers. What's the rationale for disabling the warnings?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @magdmartin didn't like the trunaction markers. So, ??? Not sure what to do here, up to both of you.

},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand Down
Loading