https://github.com/dragonflyoss/d7y.io

Source for the d7y.io
https://github.com/dragonflyoss/d7y.io

cloud-native cncf dragonfly p2p website

Last synced: about 20 hours ago
JSON representation

Source for the d7y.io

• Host: GitHub
• URL: https://github.com/dragonflyoss/d7y.io
• Owner: dragonflyoss
• License: apache-2.0
• Created: 2023-09-01T03:14:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-20T06:58:18.000Z (7 days ago)
• Last Synced: 2024-12-20T07:33:46.753Z (7 days ago)
• Topics: cloud-native, cncf, dragonfly, p2p, website
• Language: JavaScript
• Homepage: https://d7y.io
• Size: 37.4 MB
• Stars: 8
• Watchers: 14
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Roadmap: docs/roadmap/v2.0.md

Awesome Lists containing this project

README

        
# Dragonfly Website

This repository contains the source code for [d7y.io](https://d7y.io).

It's built by [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Add or Update Docs

When you add or modify the docs,

these five files(`docs/`, `docs/resource/`, and `sidebars/docs.js`) should be taken into consideration.

1. Create a markdown file in the directory `docs/`. All markdown files need to follow the format,

   that the title at the beginning should be in the following format:

   ```markdown

   ---

   title: Title Name

   ---

   ```

2. If you need image resources in markdown, put the image in the `docs/resource/` directory.

   you should put the image resources here and use a relative path like below:

   ```markdown

   ![alt](./resources/example.png)

   ```

3. `sidebars/docs.js`, this file contain the navigation information.

   Please read [the official docs of docusaurus](https://docusaurus.io/docs/sidebar) to learn how to write `sidebar.js`.

   ```js

   module.exports = {

     docs: [

       {

         type: "category",

         label: "Markdown Features",

         link: {

           type: "doc",

           id: "guides/markdown-features/introduction",

         },

         items: [

           "guides/markdown-features/react",

           "guides/markdown-features/tabs",

           "guides/markdown-features/code-blocks",

           "guides/markdown-features/admonitions",

           "guides/markdown-features/headings",

           "guides/markdown-features/inline-toc",

           "guides/markdown-features/assets",

           "guides/markdown-features/plugins",

           "guides/markdown-features/math-equations",

           "guides/markdown-features/head-metadata",

         ],

       },

     ],

   }

   ```

## Website Development

### Installation

```shell

yarn install

```

### Local Development

```shell

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

```shell

yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.