This website was created with Docusaurus.

• Get Started in 5 Minutes
• Directory Structure
• Editing Content
• Adding Content
• Full Documentation

1. Ensure NodeJS is installed

$ node -v
$ npm -v

2. Install and run Docusaurus locally

$ git clone git@github.com:<your fork>/{project name}.git
$ cd {project name}

# Download dependencies
$ yarn --cwd website install

# Generate contributing.md page
./scripts/build-contribute-page.sh

$ yarn --cwd website start

This will open a browser on http://localhost:3300

Your project file structure should look something like this

/
  docs/
    home.md
    roadmap.md
    team.md
  website/
    pages/en
      index.js
    static/
      css/
      img/
    package.json
    sidebars.json
    siteConfig.js

This website only includes one page, the index.js, which serves the / root path of the website.

You can edit contents there, feel free to check other index pages to take inspiration:

• FDC3 - https://github.com/finos/FDC3/blob/master/website/pages/en/index.js
• Financial Objects - https://github.com/finos/finos-fo/blob/master/website/pages/en/index.js

Edit docs by navigating to docs/ and editing the corresponding document:

docs/doc-to-be-edited.md

---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here

1. Create the doc as a new markdown file in /docs, example docs/newly-created-doc.md:

---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here..

1. Refer to that doc's ID in an existing sidebar in website/sidebars.json:

// Add newly-created-doc to the Getting Started category of docs
{
  "docs": {
    "Getting Started": [
      "quick-start",
      "newly-created-doc" // new doc here
    ],
    ...
  },
  ...
}

For more information about adding new docs, click here

1. Add links to docs, custom pages or external links by editing the headerLinks field of website/siteConfig.js:

website/siteConfig.js

{
  headerLinks: [
    ...
    /* you can add docs */
    { doc: 'my-examples', label: 'Examples' },
    /* you can add custom pages */
    { page: 'help', label: 'Help' },
    /* you can add external links */
    { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' },
    ...
  ],
  ...
}

For more information about the navigation bar, click here

1. Docusaurus uses React components to build pages. The components are saved as .js files in website/pages/en:
2. If you want your page to show up in your navigation header, you will need to update website/siteConfig.js to add to the headerLinks element:

website/siteConfig.js

{
  headerLinks: [
    ...
    { page: 'my-new-custom-page', label: 'My New Custom Page' },
    ...
  ],
  ...
}

For more information about custom pages, click here.

Full documentation can be found on the website.