Skip to content

Latest commit

 

History

History
227 lines (162 loc) · 6.1 KB

README.md

File metadata and controls

227 lines (162 loc) · 6.1 KB
Raw

Decentralized Ecosystem Growth website

This website was created with Docusaurus using FINOS project documentation guidelines

What's In This Document

Get Started in 5 Minutes

  1. Make sure all the dependencies for the website are installed:

git clone https://github.com/finos-osr/finos-osr.github.io.git cd finos-osr.github.io/website

# Install dependencies
$ yarn
  1. Run your dev server:
# Start the site
$ yarn start

Directory Structure

Your project file structure should look something like this

my-docusaurus/
  docs/
    doc-1.md
    doc-2.md
    doc-3.md
  website/
    blog/
      2016-3-11-oldest-post.md
      2017-10-24-newest-post.md
    core/
    node_modules/
    pages/
    static/
      css/
      img/
    package.json
    sidebar.json
    siteConfig.js

Editing Content

Editing an existing docs page

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

Editing an existing blog post

Edit blog posts by navigating to website/blog and editing the corresponding post:

website/blog/post-to-be-edited.md

---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---

Edit me...

For more information about blog posts, click here

Adding Content

Adding a new docs page to an existing sidebar

  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/sidebar.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

Adding a new blog post

  1. Make sure there is a header link to your blog in website/siteConfig.js:

website/siteConfig.js

headerLinks: [
    ...
    { blog: true, label: 'Blog' },
    ...
]
  1. Create the blog post with the format YYYY-MM-DD-My-Blog-Post-Title.md in website/blog:

website/blog/2018-05-21-New-Blog-Post.md

---
author: Frank Li
authorURL: https://twitter.com/foobarbaz
authorFBID: 503283835
title: New Blog Post
---

Lorem Ipsum...

For more information about blog posts, click here

Adding items to your site's top navigation bar

  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

Adding custom pages

  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.

Custom CSS & Design Changes

  1. Changing logos for the Header and Footer and Favicon are done in website/siteConfig.js file in the /* path to images for header/footer */ section

Note: make sure that you add your new logos to the website/static/img folder first.

  1. Change the main logo in the "SplashContainer" area of website/index.js file.

Note: make sure that you add your new logos to the website/static/img folder first.

  1. Change the background color and the background transparent image in the website/static/css/custom.css file.

Go to the section labeled: .homeContainer

Change "background-image" - and insert your new background image file. Note - make sure you add your new background transparent image file to the website/static/img folder first.

Change "background-color" to your Project's main color (FDC3 is #0033A0)

  1. Change the .svg icons in the "gridBlock" (examples on FDC3 - the 4 .svg icons for API / Intents / Context Data / App Director) - you have to open the actual .svg files in the website/static/img folder with a program like Adobe Illustrator. Change the color of the entire file to your Project's main color (FDC3 is #0033A0) - and then save the file. The icon will change color. (NOote - If there is a way to change the .svg's using CSS, have not been able to do so yet. It should be possible.)

  2. Change the section header titles (example for FDC3: Use Cases & Who is Usind FDC3) by changing the website/static/css/custom.css file. Change the h2 tags for .featureShowcaseSection h2 and .productShowcaseSection h2 to your Project's color (FDC3 is #0033A0).

  3. Interior Introduction Page - Change logo by on this page (example for FDC3: docs/fdc3-intro.md) by changing the "(assets/fdc3-logo.png)" to the new logo name.

Note: make sure that you add your new logo to the docs/assets folder first - this is a separate image repository from the "website" part.

Full Documentation

Full documentation can be found on the website.