Skip to content

dragonflyoss/website

Repository files navigation

website

All Website Material of Dragonfly

开发前请仔细阅读https://docsite.js.org

准备

  • 确保终端中有安装node
  • 在终端中执行npm i docsite -g全局安装docsite
  • git下载整个工程文件
  • 进入工程目录,执行 npm i执行依赖安装
  • 执行docsite start进行本地验证查看
  • 提交代码并创建pull request

文档编写及放置

一般文档

放置在docs/en-usdocs/zh-cn下,分别对应中文文档和英文文档,中英文件名需保持一致。

开发者文档

放置在docs/en-us/developersdocs/zh-cn/developers下,分别对应中文文档和英文文档,中英文件名需保持一致。菜单配置在site_config/developers.js中。

博客文档

放置在blog/en-usblog/zh-cn下,分别对应中文文档和英文文档,中英文件名需保持一致。 内容形式为

---
hidden: false
title: title
keywords: keywords1,keywords2
description: some description
author: author name
date: 2018-12-29
---

博客文档会按时间先后自动进行排序,无需进行菜单配置.

暂时不想显示的文档hidden设为true

下载页文档

对应blog/en-us/download.mdblog/zh-cn/download.md,分别对应中文文档和英文文档。

其他