Skip to content

Commit

Permalink
chore: release 0.7.0 (#387)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul authored Jun 11, 2021
1 parent 965e190 commit 9862c3b
Show file tree
Hide file tree
Showing 696 changed files with 40,470 additions and 1,395 deletions.
20 changes: 15 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,54 @@ name: ci
on:
push:
branches:
- master
- main
- dev
pull_request:
branches:
- master
- main
- dev

jobs:
ci:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
node: [12]
os: [ubuntu-latest] # macos-latest, windows-latest - TODO: Fix sharp on Windows
node: [16]

steps:
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}

# Checkout repositoroy
- name: checkout
uses: actions/checkout@master

# Cache node_modules
- name: cache node_modules
uses: actions/cache@v2
with:
path: node_modules
key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}

# Instal deps
- name: Install dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: yarn

# Run linting
- name: Lint
run: yarn lint

# Run tests
- name: Run tests
run: yarn jest
run: yarn test

# Build Docus package
- name: Build
run: yarn build

# Code coverage
# - name: Coverage
# uses: codecov/codecov-action@v1
3 changes: 1 addition & 2 deletions docs/components/AppFooter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
flex
items-end
text-gray-700
dark:text-gray-400
dark:hover:text-gray-100
dark:text-gray-400 dark:hover:text-gray-100
hover:text-gray-600
mb-3
sm:mb-0
Expand Down
6 changes: 3 additions & 3 deletions docs/components/AsideBottom.vue
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ export default defineComponent({
icon: 'IconWindi'
},
{
title: 'Nuxt Content',
url: 'https://content.nuxtjs.org',
icon: 'IconNuxtContent'
title: 'CodeSandbox',
url: 'https://codesandbox.io/embed/docus-starter-1xsm7?hidenavigation=1&theme=dark',
icon: 'IconCodeSandbox'
}
]
}
Expand Down
4 changes: 4 additions & 0 deletions docs/components/HeaderNavigation.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@
<ButtonLink v-show="$route.path === '/'" href="/get-started/installation" size="small" bold>
Get started
</ButtonLink>

<ButtonLink v-show="$route.path.includes('templates')" href="/get-started/installation" size="small" bold>
Back to Docs
</ButtonLink>
</div>
</template>
2 changes: 1 addition & 1 deletion docs/components/icons/IconLighthouse.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<svg height="2500" viewBox="0 0 512 548.20728733" width="2500" xmlns="http://www.w3.org/2000/svg">
<svg height="64" viewBox="0 0 512 548.20728733" width="64" xmlns="http://www.w3.org/2000/svg">
<g fill="none" fill-rule="evenodd">
<circle cx="256" cy="256" fill="#0535c1" fill-rule="nonzero" r="256" />
<path d="m311.273 116.364h151.272v151.272h-151.272z" />
Expand Down
1 change: 1 addition & 0 deletions docs/components/icons/IconMarkdown.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 26 26"
height="64"
fill="currentColor"
class="text-gray-900 dark:text-gray-100"
>
Expand Down
2 changes: 1 addition & 1 deletion docs/components/icons/IconPuzzle.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64">
<path
fill="#00DC82"
d="M48,27v-5c0-2.761-2.239-5-5-5h-5c-1.105,0-2-0.895-2-2v-2c0-3.866-3.134-7-7-7h0 c-3.866,0-7,3.134-7,7v2c0,1.105-0.895,2-2,2h-5c-2.761,0-5,2.239-5,5v5c0,1.105,0.895,2,2,2h2c3.866,0,7,3.134,7,7v0 c0,3.866-3.134,7-7,7h-2c-1.105,0-2,0.895-2,2v5c0,2.761,2.239,5,5,5h28c2.761,0,5-2.239,5-5v-5c0-1.105,0.895-2,2-2h2 c3.866,0,7-3.134,7-7v0c0-3.866-3.134-7-7-7h-2C48.895,29,48,28.105,48,27z"
Expand Down
2 changes: 1 addition & 1 deletion docs/components/icons/IconSSG.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<svg fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48" width="48px" height="48px">
<svg fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48" width="64" height="64">
<path
d="M 10.5 6 C 10.3105 6 10.124082 6.0104805 9.9394531 6.0292969 C 9.571481 6.0667987 9.2141905 6.1413291 8.8710938 6.2480469 C 7.1472189 6.7842455 5.7842455 8.1472189 5.2480469 9.8710938 C 5.1413291 10.21419 5.0667987 10.571481 5.0292969 10.939453 C 5.0292305 10.940097 5.0293631 10.940762 5.0292969 10.941406 C 5.0106094 11.125412 5 11.311158 5 11.5 L 5 13.5 L 5 36.5 C 5 39.519774 7.4802259 42 10.5 42 L 37.5 42 C 40.519774 42 43 39.519774 43 36.5 L 43 13.5 L 43 11.5 C 43 11.310603 42.989737 11.124126 42.970703 10.939453 C 42.933201 10.571481 42.858671 10.21419 42.751953 9.8710938 C 42.215754 8.1472189 40.852781 6.7842455 39.128906 6.2480469 C 38.78581 6.1413291 38.428519 6.0667987 38.060547 6.0292969 C 38.059905 6.0292315 38.059235 6.029362 38.058594 6.0292969 C 37.874547 6.0103939 37.688736 6 37.5 6 L 10.5 6 z M 10.5 9 C 11.328 9 12 9.672 12 10.5 C 12 11.328 11.328 12 10.5 12 C 9.672 12 9 11.328 9 10.5 C 9 9.672 9.672 9 10.5 9 z M 15.5 9 C 16.328 9 17 9.672 17 10.5 C 17 11.328 16.328 12 15.5 12 C 14.672 12 14 11.328 14 10.5 C 14 9.672 14.672 9 15.5 9 z M 21.5 9 L 37.5 9 C 38.328 9 39 9.672 39 10.5 C 39 11.328 38.328 12 37.5 12 L 21.5 12 C 20.672 12 20 11.328 20 10.5 C 20 9.672 20.672 9 21.5 9 z M 8 15 L 40 15 L 40 32.945312 L 32.990234 26.140625 A 1.50015 1.50015 0 0 0 32.986328 26.136719 C 32.208181 25.38535 31.18685 25 30.173828 25 C 29.16122 25 28.13988 25.385387 27.361328 26.138672 L 25.3125 28.121094 L 19.132812 22.142578 C 18.35636 21.389748 17.336076 21 16.318359 21 C 15.299078 21 14.280986 21.392173 13.505859 22.140625 A 1.50015 1.50015 0 0 0 13.501953 22.144531 L 8 27.490234 L 8 15 z M 29 18 A 2 2 0 0 0 29 22 A 2 2 0 0 0 29 18 z M 16.318359 24 C 16.578643 24 16.835328 24.09366 17.044922 24.296875 A 1.50015 1.50015 0 0 0 17.046875 24.298828 L 23.154297 30.207031 L 14.064453 39 L 10.5 39 C 9.1017741 39 8 37.898226 8 36.5 L 8 31.671875 L 15.591797 24.294922 L 15.589844 24.298828 C 15.802758 24.093293 16.059641 24 16.318359 24 z M 30.173828 28 C 30.438806 28 30.692485 28.09229 30.902344 28.294922 L 39.933594 37.0625 C 39.683303 38.182061 38.703903 39 37.5 39 L 18.380859 39 L 29.447266 28.294922 C 29.654714 28.094207 29.910436 28 30.173828 28 z"
/>
Expand Down
2 changes: 1 addition & 1 deletion docs/components/icons/IconVueTelescope.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96" fill="none">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96" fill="none" width="64" height="64">
<path
d="M35.2276 68.8623L43.5012 83.1926C45.5006 86.6558 50.4993 86.6558 52.4989 83.1926L83.3797 29.7053H57.8349L35.2276 68.8623Z"
fill="currentColor"
Expand Down
2 changes: 1 addition & 1 deletion docs/components/icons/IconZap.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<svg xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 48 48">
<svg xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 48 48" width="64" height="64">
<polygon
fill="#ffae0b"
points="16.828,5.828 29.966,5.828 25.172,19.414 33.966,19.414 18.621,43.138 21.034,26.379 12.828,26.379"
Expand Down
74 changes: 38 additions & 36 deletions docs/content/1.get-started/1.installation.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,36 @@
# Installation

> Setting up beautiful documentation with Docus is one command away 🤙
> Setting up a beautiful website with Docus is one command away. 🤙
Docus is a pre-configured [Nuxt](https://nuxtjs.org) application, with [Windi CSS](https://windicss.org) and [Nuxt Content](https://content.nuxtjs.org).
Docus is an opinionated [Nuxt](https://nuxtjs.org) application that allows you to generate **content-based websites** with ease.

## System Requirements

- Node.js [12](https://nodejs.org/en/) or later
- MacOS, Windows, and Linux are supported
- Node.js [14](https://nodejs.org/en/) or above.
- MacOS, Windows or Linux.

## Quick start

### GitHub Template

Start your documentation in a new GitHub repository by using our [GitHub template](https://github.com/nuxtlabs/docus-starter):
### Clone locally

::button-link{size="medium" blank href="https://github.com/nuxtlabs/docus-starter/generate"}
Create a repo with the Docus starter
::
You can download the starter locally using [degit](https://github.com/Rich-Harris/degit).

### Download locally
This allows you to add documentation to your existing repository.

You can download the starter locally using [degit](https://github.com/Rich-Harris/degit). This allows you to add documentation to your existing repository.

```
```bash
npx degit nuxtlabs/docus-starter#main docs
```

This command will create a new folder named `docs/` and download the Docus starter inside.

### GitHub Template

Start your documentation in a new GitHub repository by using our [GitHub template](https://github.com/nuxtlabs/docus-starter):

::button-link{size="medium" blank href="https://github.com/nuxtlabs/docus-starter/generate"}
Create a repo with the Docus starter
::

### Vercel Template

Vercel lets you set up the starter on your favorite Git provider (GitHub, GitLab or Bitbucket) - and deploy for free.
Expand All @@ -37,39 +39,25 @@ Vercel lets you set up the starter on your favorite Git provider (GitHub, GitLab
Create and deploy using Vercel
::

**See it in action**:

::video-player{loop playsinline controls}
sources:
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.webm
type: video/webm
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.mp4
type: video/mp4
- src: https//res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.ogv
type: video/ogg
poster: https://res.cloudinary.com/nuxt/video/upload/v1612886404/docus/docus-vercel_wwaryz.jpg
---
::

## Directory Structure

The directory structure of a minimal Docus project is the following:
The directory structure of a minimal **Docus** project is the following:

```bash
| content/
---| index.md
---| settings.json
| static/
---| icon.png
---| preview.png
| nuxt.config.js
| nuxt.config.{ts|js}
| docus.config.{ts|js}
| package.json
```

- Configure Docus with [content/settings.json](/get-started/configuration)
- Write your documentation within [content/{locale}](/usage/content)
- Use our [included components](/usage/components)
- Manage your images and assets in [static/](/usage/assets)
- Configure Docus with [docus.config.js](/get-started/configuration).
- Write your documentation within [content/](/writing/my-first-page).
- Use our [included components](/theme/components) or yours.
- Manage your images and assets in [static/](/features/assets).

## Start docus

Expand All @@ -81,4 +69,18 @@ yarn dev

The development server will listen on [http://localhost:4000](http://localhost:4000)

Checkout the [Deployment](/more/deployment) section when you are ready to publish your documentation.
Checkout the [Deployment](/feature/deployment) section when you are ready to publish your documentation.

## Demo

::video-player{loop playsinline controls}
sources:
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.webm
type: video/webm
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.mp4
type: video/mp4
- src: https//res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.ogv
type: video/ogg
poster: https://res.cloudinary.com/nuxt/video/upload/v1612886404/docus/docus-vercel_wwaryz.jpg
---
::
Loading

2 comments on commit 9862c3b

@vercel
Copy link

@vercel vercel bot commented on 9862c3b Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on 9862c3b Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docus – ./

docus-nuxtlabs.vercel.app
docus-git-main-nuxtlabs.vercel.app
docus.com

Please sign in to comment.