Skip to content

Commit 3c9928c

Browse files
committed
Restructured menu
1 parent c99f516 commit 3c9928c

File tree

6 files changed

+35
-5
lines changed

6 files changed

+35
-5
lines changed

docs/api.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
name: API
33
route: /api
4+
order: 2
45
---
56

67
# API

docs/playground.mdx renamed to docs/examples.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
name: Playground
3-
route: /playground
2+
name: Examples
3+
route: /examples
4+
order: 3
45
---
56

6-
# Playground
7+
# Examples
78

89
import { Playground } from 'docz'
910
import ReactTimer from '../src/index'

docs/getting-started/changelog.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Changelog
3+
route: /changelog
4+
order: 3
5+
menu: Getting Started
6+
---
7+
8+
# Changelog

docs/getting-started/installation.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Installation
3+
route: /installation
4+
order: 2
5+
menu: Getting Started
6+
---
7+
8+
# Installation

docs/introduction.mdx renamed to docs/getting-started/introduction.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
name: Introduction
33
route: /
4+
order: 1
5+
menu: Getting Started
46
---
57

68
# Introduction

doczrc.js

+12-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@ module.exports = {
22
base: '/react-timer/',
33
title: 'React Timer',
44
hashRouter: true,
5-
ignore: ['readme.md'],
6-
src: './docs'
5+
ignore: ['README.md', 'example/README.md'],
6+
src: './docs',
7+
menu: [
8+
{
9+
name: 'Getting Started',
10+
menu: [
11+
{ name: 'Introduction', route: '/' },
12+
{ name: 'Installation', route: '/installation' },
13+
{ name: 'Changelog', route: '/changelog' }
14+
]
15+
}
16+
]
717
}

0 commit comments

Comments
 (0)