Giter Club home page Giter Club logo

olympus-docs's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Notes

  1. not using blog - we have deleted the blog directory & disabled the blog plugin
  2. we are using typescript, which has some uniqueness within docusaurus
  3. Embedding dynamic content? We use MDX-Embed
    • docs/intro.mdx shows an example with youtube
    • Don't use mdx. It breaks the CMS.

How to Edit these docs

  • Full Editing functionality is possible by following Installation, Local Development and Build steps below.
  • CMS based editing is possible via Netlify CMS, though there are some functionality gaps / tradeoffs. See Partial Editing with Netlify CMS below.

Full Editing

Installation

yarn

Local Development

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.

Build

Builds are automatic via CI/CD pipeline using fleek.

Deployment

PRs are automatically deployed on fleek.

Partial Editing with Netlify CMS

  • Netlify CMS is available at https://admin-docs.olympusdao.finance/.
  • Netlify CMS is served from the netlify-cms branch. All changes to Netlify CMS config happen in static/admin. If you make a change here you need to push that change first to main and then merge that change down to netlify-cms branch.
  • it requires login with github credentials
  • all changes will read/write against the main branch
  • all submitted changes will be submitted as pull requests
  • Netlify CMS ONLY READS and WRITES DATA to/from github... it does not read/write any local changes you might have on your local machine
  • Netlify CMS does not parse mdx files, so none of the mdx files appear
  • Netlify CMS parses each docs directory separately, so a new directory would require updates to config.yml

olympus-docs's People

Contributors

0xlienid avatar 0xrusowsky avatar 0xshaft avatar appleseed-iii avatar brightiron avatar cptnanon avatar dependabot[bot] avatar hohmward avatar ind-igo avatar oighty avatar okkothejawa avatar semidiomercurio avatar unbanksy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.