michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[ci] yarn format

Browse source
This commit is contained in:
matthewp 2021-06-11 19:56:31 +00:00 committed by GitHub Actions
parent 348d829e94
commit 68c6bc7d76
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/docs/src/config.ts
View file

@ -1,6 +1,6 @@
export const sidebar = [ export const sidebar = [
{ {
text: 'Introduction', text: 'Introduction',
link: '/', link: '/',
children: [ children: [
{ text: 'Getting Started', link: '/getting-started' }, { text: 'Getting Started', link: '/getting-started' },

6
examples/docs/src/pages/getting-started.md
View file

@ -13,7 +13,7 @@ The page navigation, through the side bar on the left, needs to be manually upda
```ts ```ts
export const sidebar = [ export const sidebar = [
{ {
text: 'Introduction', text: 'Introduction',
link: '/', link: '/',
children: [ children: [
{ text: 'Getting Started', link: '/getting-started' }, { text: 'Getting Started', link: '/getting-started' },
@ -22,17 +22,17 @@ export const sidebar = [
}, },
]; ];
``` ```
You can change this file to match the pages you want to display, the items within `children` can also have children elements, but only the first level and second levels will be displayed. You can change this file to match the pages you want to display, the items within `children` can also have children elements, but only the first level and second levels will be displayed.
The page navigation is generated in the `src/components/SiteSidebar.astro`, so if you want to change the depth of elements displayed, styles, etc, that's the place to go. The page navigation is generated in the `src/components/SiteSidebar.astro`, so if you want to change the depth of elements displayed, styles, etc, that's the place to go.
## Section navigation ## Section navigation
The section navigation, through the side bar on the right, is automatically generated by the `src/components/DocSidebar.tsx` file, it uses the meta-data from markdown files to generate the structure you see. The section navigation, through the side bar on the right, is automatically generated by the `src/components/DocSidebar.tsx` file, it uses the meta-data from markdown files to generate the structure you see.
By default only elements from depth 2 to 5 will be displayed, and at the moment doesn't work for `.astro files`. By default only elements from depth 2 to 5 will be displayed, and at the moment doesn't work for `.astro files`.
## Other Components ## Other Components
### Footer ### Footer