summaryrefslogtreecommitdiff
path: root/examples/docs/src
diff options
context:
space:
mode:
authorGravatar matthewp <matthewp@users.noreply.github.com> 2021-06-11 19:56:31 +0000
committerGravatar GitHub Actions <actions@github.com> 2021-06-11 19:56:31 +0000
commit68c6bc7d76517469ca7277a34d929ec8ad939d74 (patch)
tree9eac290131919f7a0da0aae80a7272ce425deed0 /examples/docs/src
parent348d829e94b778874d13c8e07a5105321deab025 (diff)
downloadastro-68c6bc7d76517469ca7277a34d929ec8ad939d74.tar.gz
astro-68c6bc7d76517469ca7277a34d929ec8ad939d74.tar.zst
astro-68c6bc7d76517469ca7277a34d929ec8ad939d74.zip
[ci] yarn format
Diffstat (limited to 'examples/docs/src')
-rw-r--r--examples/docs/src/config.ts2
-rw-r--r--examples/docs/src/pages/getting-started.md6
2 files changed, 4 insertions, 4 deletions
diff --git a/examples/docs/src/config.ts b/examples/docs/src/config.ts
index 96edecaf3..4b6268e23 100644
--- a/examples/docs/src/config.ts
+++ b/examples/docs/src/config.ts
@@ -1,6 +1,6 @@
export const sidebar = [
{
- text: 'Introduction',
+ text: 'Introduction',
link: '/',
children: [
{ text: 'Getting Started', link: '/getting-started' },
diff --git a/examples/docs/src/pages/getting-started.md b/examples/docs/src/pages/getting-started.md
index e569ca790..e034a47ca 100644
--- a/examples/docs/src/pages/getting-started.md
+++ b/examples/docs/src/pages/getting-started.md
@@ -13,7 +13,7 @@ The page navigation, through the side bar on the left, needs to be manually upda
```ts
export const sidebar = [
{
- text: 'Introduction',
+ text: 'Introduction',
link: '/',
children: [
{ 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.
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
-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`.
-
## Other Components
### Footer