Dragonfly Website

This repository contains the source code for d7y.io.

It's built by Docusaurus 2, 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:

   ---
   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:

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

3. sidebars/docs.js, this file contain the navigation information. Please read the official docs of docusaurus to learn how to write sidebar.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

yarn install

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

yarn build

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