Git Product home page Git Product logo

janus-idp.github.io's Introduction

janus-idp.github.io

This is a monorepo that contains the source code of the community website and automatically deploys to janus-idp.io.

Status

Deploy the Website to Pages Push website

Prerequisite

How to run the website locally

Install the dependencies

After getting the latest website version with git pull, you need to install the required dependencies with the following command:

pnpm i

Start the website locally

Run the following command to start the web server:

pnpm dev --filter=website

How to update the website

Go to the apps/website folder

Blog

To add or update a blog, you need to go to the blog sub folder. The blog must be in Markdown format (MDX).

Documentation

To add or update documentation, you need to go to the docs sub folder. The documentation must be in Markdown format (MD).

Plugins

To add or update a plugin, you need to edit the content/plugin-list.ts file. The content of the plugin page is coming from the README of the plugin itself in the plugin repo.

If you need to change the page template for plugins, you may need to update these files:

  • apps/website/docusaurus.config.js
  • packages/ui/components/plugin-header/plugin-header.tsx
  • packages/ui/types/index.ts

How to deploy the website

The deployment is automated as soon as a PR is merged. The build takes 2 to 3 minutes to build and deploy.

If you do not see your changes, please refresh the page in your browser.

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.