Skip to content

Commit

Permalink
docs: update home page
Browse files Browse the repository at this point in the history
  • Loading branch information
katallaxie committed Jan 18, 2024
1 parent 99806fa commit 929c436
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
24 changes: 23 additions & 1 deletion src/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,26 @@
title: Home
---

# Youd docs
# 👋 Welcome

This is a teeny tiny template for starting a docs project.

## Setup

The template is intended to be used with [Codespaces](https://github.com/features/codespaces) and [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).

```bash
npm i
```

Get a preview of the docs.

```bash
npm run dev
```

Open [localhost:3000](http://localhost:3000)

## Resources

* [Theme Configuration](https://nextra.site/docs/docs-theme/theme-configuration)
3 changes: 2 additions & 1 deletion src/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ const config = {
logo: <span>Docs Template</span>,
project: {
link: 'https://github.com/zeiss/docs-template'
}
},
docsRepositoryBase: 'https://github.com/zeiss/docs-template/tree/main'
}

export default config

0 comments on commit 929c436

Please sign in to comment.