Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
74c938d
refactor: move tokens, typography and elements to Docus
bdrtsky Apr 6, 2023
94a2a5e
chore: missing app config data
atinux Apr 6, 2023
d4814c4
Revert "chore: missing app config data"
bdrtsky Apr 7, 2023
bfc1813
Revert "refactor: move tokens, typography and elements to Docus"
bdrtsky Apr 7, 2023
effa138
feat: improve DocsAsideTree; add collapsible disabling option
bdrtsky Apr 7, 2023
dba0c58
Merge branch 'main' into v2
bdrtsky Apr 7, 2023
a3a0e67
fix(DocsPageLayout): spacing
bdrtsky Apr 10, 2023
6db5dce
Merge branch 'main' into v2
bdrtsky Apr 11, 2023
ad1e778
cleanup color tokens; RTL support
bdrtsky Apr 17, 2023
3d58ee5
feat: DocsPrevNext rewrite
bdrtsky Apr 18, 2023
848c1aa
progress Landing
bdrtsky Apr 27, 2023
f0e00ff
init components restructuring; finish Landing; finish AppHeader compo…
bdrtsky May 10, 2023
de7b7b1
tokenize AppFooter
bdrtsky May 10, 2023
7f14c82
finish Landing and Layout components
bdrtsky May 11, 2023
42137c2
restructure components
bdrtsky May 11, 2023
f44b861
improve Landing Glow gradients; init Hero docs
bdrtsky May 12, 2023
57a5c52
Hero docs
bdrtsky May 15, 2023
8248502
improve CardGrid; CardGrid docs; SectionHeader component
bdrtsky May 15, 2023
bc0679e
hide header navigation; add CardGrid MDC example
bdrtsky May 15, 2023
79c10ae
add browser detection plugin and disable Glow in Firefox
bdrtsky May 15, 2023
5c99c3a
Card docs
bdrtsky May 16, 2023
3cdfbf6
SectionHeader improvements and docs
bdrtsky May 16, 2023
9a1b930
Layout components docs
bdrtsky May 17, 2023
86ba472
Merge branch 'main' into v2
Tahul May 23, 2023
1b080f0
chore(merge): merge from main; update
Tahul May 23, 2023
20caedb
chore(cleanup): clean
Tahul May 23, 2023
9802f35
docs: AppHeader
bdrtsky May 23, 2023
b9e0a1c
chore(deps): use beta releases of nuxt-themes dependencies
Tahul May 25, 2023
551419c
chore(starter): update starter to beta release
Tahul May 25, 2023
7bbaf2b
chore(release): release v2.0.0-beta.1
Tahul May 25, 2023
1804617
chore(lockfile): update
Tahul May 25, 2023
53cef78
docs: App components
bdrtsky Jun 2, 2023
c050092
init Docs docs
bdrtsky Jun 5, 2023
0b1ce39
update Card padding
bdrtsky Jun 5, 2023
9996874
fix: update landing gradients
bdrtsky Jun 6, 2023
2416fc8
add docs icons
bdrtsky Jun 6, 2023
62384c5
docs: add typography docs; some restructure
bdrtsky Jun 6, 2023
5b3874e
docs: Drawer and Announce
bdrtsky Jun 6, 2023
654c6fb
chore(deps): up
Tahul Jun 9, 2023
90cfe4a
chore(release): release v2.0.0-beta.2
Tahul Jun 9, 2023
36d3c76
chore(deps): up
Tahul Jun 9, 2023
9b37069
fix: replace isIndex with isBasicLayout
bdrtsky Jun 12, 2023
9682397
chore(release): release v2.0.0-beta.3
Tahul Jun 12, 2023
a3fedc5
fix: update Elements Drawer usage; rename useMenu to useBodyLock and …
bdrtsky Jun 12, 2023
7a47c1a
docs: Modal and Drawer
bdrtsky Jun 12, 2023
363c90d
fix: update AppHeaderDrawer with new Modal
bdrtsky Jun 15, 2023
b02c9ad
fix: remove fluid layout option
bdrtsky Jun 19, 2023
cb6442c
chore(release): release v2.0.0-beta.4
Tahul Jun 19, 2023
ba57707
chore(deps): up
Tahul Jun 19, 2023
84b96ae
chore(release): release v2.0.0-beta.5
Tahul Jun 19, 2023
7fa9b5e
chore(deps): up
Tahul Jun 21, 2023
d51eb0e
chore(release): release v2.0.0-beta.6
Tahul Jun 21, 2023
ff99613
chore(deps): up
Tahul Jun 21, 2023
420a2e2
chore(release): release v2.0.0-beta.7
Tahul Jun 21, 2023
e078c54
chore(deps): upgrade elements (fix)
Tahul Jun 21, 2023
58baba5
chore(release): release v2.0.0-beta.8
Tahul Jun 21, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .starters/default/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@ export default defineAppConfig({
edit: true
},
aside: {
level: 0,
level: 1,
collapsed: false,
exclude: []
exclude: [],
navigation: true
},
main: {
padded: true,
fluid: true
},
header: {
title: '',
logo: true,
showLinkIcon: true,
exclude: [],
fluid: true
navigation: false
},
footer: {
iconLinks: [
Expand Down
243 changes: 167 additions & 76 deletions .starters/default/content/0.index.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,190 @@
---
title: Home
navigation: false
layout: page
main:
fluid: false
layout: basic
---

:ellipsis{right=0px width=75% blur=150px}
<!-- :hero-visuals -->

::block-hero
::glow
---
cta:
- Get started
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/nuxt-themes/docus
top: calc(0px - var(--docus-app-header-height))
height: calc(var(--hero-height) + var(--docus-app-header-height) + 20rem)
maskGradient:
light:
initial: radial-gradient(circle at 51% 64%, rgba(0,0,0, 1) -7%, rgba(0,0,0, 0) 70%)
xl: radial-gradient(at 70% 45%, red, rgba(255, 0, 0, 0) 85%)
dark:
initial: radial-gradient(circle at 51% 64%, rgba(0,0,0, 1) -7%, rgba(0,0,0, 0) 70%)
xl: radial-gradient(at 70% 45%, rgba(0, 0, 0, 1), rgba(0, 0, 0, 0) 85%)
gradient:
light:
initial: radial-gradient(circle at 10% 50%, {color.secondary.500} 4%, {color.primary.200} 25%, {color.primary.500} 65%)
xl: radial-gradient(circle at 10% 50%, {color.secondary.200} 15%, {color.primary.500} 60%, {color.primary.400} 55%, {color.primary.400} 75%, {color.secondary.500} 90%)
dark:
initial: radial-gradient(circle at 10% 50%, {color.secondary.500}, {color.primary.500} 45%, {color.primary.200} 82%)
xl: radial-gradient(circle at 10% 50%, {color.secondary.700} 15%, {color.primary.500} 60%, {color.primary.600} 55%, {color.primary.600} 75%, {color.secondary.500} 90%)
noise: true
backgroundImage: linear-gradient(transparent 75%, {docus.body.backgroundColor})
---
::

#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)
::
::container-section
::hero

#support
::terminal
---
content:
- npx nuxi@latest init -t themes/docus
- cd docs
- npm install
- npm run dev
---
#announce
::announce{href=https://docus.dev/v2}
Docus v2 is out 🎉
::

#title
The best place to start your documentation.

#description
Write pages in [:icon{name=mdi:language-markdown}]{style="margin-right:4px"} [Markdown](https://content.nuxtjs.org), use [:icon{name=vscode-icons:file-type-vue}]{style="margin-right:4px"} [Vue](https://vuejs.org) components and enjoy the power of [:icon{name=vscode-icons:file-type-nuxt}]{style="margin-right:4px"} [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)
::

#actions
::button-link{href=/introduction/getting-started size=medium}
Get started
::
::button-link{href=https://github.com/nuxt-themes/docus size=medium color=gray ghost blank}
Open on GitHub →
::

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

::card-grid
#title
What's included
::container-section{margin="{space.24} 0" padding="{space.24} 0"}

#root
:ellipsis{left=0px width=40rem top=10rem blur=140px}
::glow
---
height: 100%
maskGradient:
light:
initial: radial-gradient(circle at 51% 44%, rgba(0,0,0, 1) -16%, rgba(0,0,0, 0) 74%)
lg: radial-gradient(at 43% 53%, red, rgba(255, 0, 0, 0) 85%)
dark:
initial: radial-gradient(circle at 51% 44%, rgba(0,0,0, 1) -16%, rgba(0,0,0, 0) 84%)
lg: radial-gradient(at 43% 53%, rgba(0,0,0, 1), rgba(255, 0, 0, 0) 85%)
gradient:
light:
initial: radial-gradient(circle at 40% 50%, {color.primary.400}, {color.primary.400} 52%)
lg: conic-gradient({color.secondary.200} 0%, {color.secondary.200} 12%, {color.secondary.300} 22%, {color.secondary.500} 30%, {color.primary.300} 44%)
dark:
initial: radial-gradient(circle at 40% 50%, {color.primary.600}, {color.primary.700} 52%)
lg: radial-gradient(circle at 44% 72%, {color.primary.600} 0%, {color.primary.700} 12%, {color.primary.800} 22%)
noise: true
backgroundImage: linear-gradient(transparent 75%, {docus.body.backgroundColor})
afterBlendMode:
light: color
dark: multiply
---
::

#default
::card{icon=logos:nuxt-icon}
#title
Nuxt Architecture
#description
Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem.
::
:section-header{title="What's included" subtitle="Features"}

::card-grid{cols=6}

::card{icon=IconNuxtStudio}
#title
Nuxt Studio ready
#description
Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio).
::
#default
::card{icon=logos:nuxt-icon lights noise}
---
col:
initial: 6
sm: 2
row: 1
---
#title
Nuxt Architecture
#description
Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem.
::

::card{icon=logos:vue}
#title
Vue Components
#description
Use built-in components (or your own!) inside your content.
::
::card{icon=IconNuxtStudio lights noise}
---
col:
initial: 6
sm: 2
row:
initial: 1
sm: 2
---
#title
Nuxt Studio ready
#description
Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio).
::

::card{icon=simple-icons:markdown}
#title
Write Markdown
#description
Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc).
::
::card{icon=logos:vue lights noise}
---
col:
initial: 6
sm: 2
row: 1
---
#title
Vue Components
#description
Use built-in components (or your own!) inside your content.
::

::card{icon=noto:rocket}
#title
Deploy anywhere
#description
Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com).
::
::card{icon=simple-icons:markdown lights noise}
---
col:
initial: 6
sm: 2
---
#title
Write Markdown
#description
Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc).
::

::card{icon=noto:puzzle-piece}
#title
Extensible.
#description
Customize the whole design, or add components using slots - you can make Docus your own.
::card{icon=noto:rocket lights noise}
---
col:
initial: 6
sm: 3
---
#title
Deploy anywhere
#description
Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com).
::

::card{icon=material-symbols:token-outline lights noise}
---
col:
initial: 6
sm: 2
---

#title
Design Tokens
#description
Make Docus your own! Use [Design Tokens](https://pinceau.dev/configuration/design-tokens) to build your own Design System.
::
::
::
::
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Writing Pages
# Writing Content

Docus is made to let you write all your content in Markdown and Vue components with the MDC syntax.

Expand Down
2 changes: 1 addition & 1 deletion .starters/default/content/1.introduction/_dir.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
icon: ph:star-duotone
icon: 🚀
navigation.redirect: /introduction/getting-started
1 change: 1 addition & 0 deletions .starters/default/content/1.introduction/design-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Design System
31 changes: 31 additions & 0 deletions .starters/default/content/1.introduction/typography.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Typography

For typography, Docus uses [Nuxt Typography](https://github.com/nuxt-themes/typography).

[Nuxt Typography] is a theme to get a beautiful and customisable typography with a set of prose components for Nuxt Content

It consist of two parts: `typography` tokens and `prose` components.

Nuxt Typography expose a set of `prose` components that work seamlessly with [Nuxt Content](https://content.nuxtjs.org/). Those components include:

- `ProseA`
- `ProseBlockquote`
- `ProseCode`
- `ProseCodeInline`
- `ProseH1` - `ProseH6`
- `ProseHr`
- `ProseImg`
- `ProseUl`
- `ProseOl`
- `ProseLi`
- `ProseP`
- `ProseStrong`
- `ProseEm`
- `ProseTable`
- `ProseTbody`
- `ProseTd`
- `ProseTh`
- `ProseThead`
- `ProseTr`

Feel free to overwrite or customize the default typography tokens and prose components as you wish.
2 changes: 1 addition & 1 deletion .starters/default/content/2.api/2.composables.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const { tree } = useDocus()
</script>

<template>
<DocsAsideTree :links="tree" />
<DocsNavigation :links="tree" />
</template>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,8 @@ export default defineAppConfig({
| `header.title` | `string` | | If set to a string, will be used in the header |
| `header.showLinkIcon` | `boolean` | | If set to `true` links icons will show in the header |
| `header.exclude` | `string[]` | | An array of path to exclude out from the header navigation |
| `header.fluid` | `boolean` | `true` | Make header `Container` fluid |
| **Main** | | | |
| `main` | `object` | | Main configuration |
| `main.fluid` | `boolean` | `true` | Make main content `Container` fluid |
| `main.padded` | `boolean` | `true` | Make main content `Container` padded |
| **Aside** | | | |
| `aside` | `object` | | Aside configuration |
Expand All @@ -124,7 +122,6 @@ export default defineAppConfig({
| `footer.iconLinks[0].href` | `string` | | A link to use for the icon |
| `footer.iconLinks[0].icon` | `string` | | The icon to use (can be a component name) |
| `footer.iconLinks[0].rel` | `string` | `noopener noreferrer` | A space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types) |
| `footer.fluid` | `boolean` | `true` | Make footer `Container` fluid |
| **GitHub** | | | |
| `github` | `object` | `false` | GitHub integration configuration |
| `github.dir` | `string` | | Directory containing the files to be edited |
Expand Down
Loading