Skip to content

Commit

Permalink
docus familiarity
Browse files Browse the repository at this point in the history
  • Loading branch information
CarelessCourage committed Nov 13, 2023
1 parent bede389 commit 2091846
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 48 deletions.
14 changes: 5 additions & 9 deletions packages/docs/app.config.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
export default defineAppConfig({
docus: {
title: 'Docus',
title: 'Umbra',
description: 'The best place to start your documentation.',
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
image:
'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
socials: {
twitter: 'nuxt_js',
github: 'nuxt-themes/docus',
nuxt: {
label: 'Nuxt',
icon: 'simple-icons:nuxtdotjs',
href: 'https://nuxt.com'
}
github: 'nuxt-themes/docus'
},
github: {
dir: '.starters/default/content',
Expand All @@ -29,7 +25,7 @@ export default defineAppConfig({
fluid: true
},
header: {
logo: true,
logo: false,
showLinkIcon: true,
exclude: [],
fluid: true
Expand Down
10 changes: 10 additions & 0 deletions packages/docs/components/content/Hero.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<script lang="ts" setup></script>

<template>
<div>
<ProseH1>Umbra</ProseH1>
<ProseP> Umbra is a design system for building modern websites and applications. </ProseP>
</div>
</template>

<style scoped></style>
38 changes: 1 addition & 37 deletions packages/docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,44 +8,8 @@ main:

:ellipsis{right=0px width=75% blur=150px}

::block-hero
::Hero

---
cta:
- Get started
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/nuxt-themes/docus
---

#title
The best place to start your documentation.

#description
Write pages in [Markdown](https://content.nuxtjs.org), use [Vue](https://vuejs.org) components and enjoy the power of [Nuxt](https://nuxt.com).

#extra
::list
- **+50 Components** ready to build rich pages
- **Docs** and **Page** layouts
- Start from a `README`, scale to a framework documentation
- Navigation and Table of Contents generation
- Fully configurable design system
- Leverages [**Typography**](https://typography.nuxt.space/) and [**Elements**](https://elements.nuxt.dev)
- Used on [Content Documentation](https://content.nuxtjs.org)
::

#support
::terminal
---
content:
- npx nuxi@latest init -t themes/docus
- cd docs
- npm install
- npm run dev
---
::
::

::card-grid
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/content/1.introduction/4.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Learn how to configure Docus.
```ts [Minimal app.config.ts]
export default defineAppConfig({
docus: {
title: 'Docus',
title: 'Umbra',
description: 'My Docus Project',
url: 'http://docus.dev'
}
Expand Down Expand Up @@ -43,7 +43,7 @@ export default defineAppConfig({
footer: {
credits: {
icon: 'IconDocus',
text: 'Powered by Docus',
text: 'Created by Samuel M. Bednarz',
href: 'https://docus.dev',
},
textLinks: [
Expand Down

0 comments on commit 2091846

Please sign in to comment.